Initial rancher-api implementation

[jordojordo]

Summary

Fixes #12705

This is the initial proposal for the rancher-api spec with a few methods on the cluster and rancher classes to interact with cluster based resources.

Note: Only the $shell hook will implemented with this PR, in further iterations we can initialize the other hooks.

Initialized by adding each plugin into the pluginDefinitions array within the installInjectedPlugins method in the shell/initialize/install-plugin.js file.

Hooks:

• $cluster
  • fetching/managing cluster level resources
• $rancher
  • when interacting with the management/local or Rancher cluster
• $shell
  • to interact with @rancher/shell components/methods
• $extension
  • for extension product related methods

This allows for Intellisense on all methods within each class for proper definitions and arguments of each method. Also adds some basic types.

---

Methods added to the $shell hook:

• growl: Dispatches a growl notification with a config to determine the:
  • title, message, type, and timeout
• modal: Opens a modal with a given config that supplies:
  • component, componentProps, resources, modalWidth, and closeOnClickOutside
• slideInPanel: Opens a Slide-In Panel from the right of the screen with a given config that supplies:
  • component, componentProps

---

Notable Changes

• Removed vue-shim template file used only in typegen script
• Removed outdated Vue 2 typing within the vue-shim.d.ts
• Added global-vue.d.ts to include typing for .vue files
• Added references to both the vue-shim.d.ts and global-vue.d.ts files within typegen.sh
  • Instead of adding the contents of vue-shim.d.ts to the types/shell/index.d.ts file, we now will add a reference to that file. Adding the full contents would cause build/typing errors.

---

Screenshots

Growl hook

Modal hook

modal-test.mp4

Slide-In Panel hook

slide-in-test.mp4

[codyrancher]

I like the groups you split the api into.

It looks like all of these will be available in components. Do you intend to expose any of these to the bootstraping methods of extensions?

[codyrancher]

Will these make the API available in the bootstraping methods of the extensions? If so, isn't there a possibility that some of the stores won't be loaded yet? We might have to make that clear or error out gracefully if that's the case.

[jordojordo]

This doesn't make the API available to extensions after some initial testing, I don't think the types are being properly referenced in an extension.

Perhaps creating a helper function to check for the existence of the store before running any commands wouldn't be a bad idea, but I believe the plugins (extensions) are initialized on line 324 which is after both the store and prototypes are created:

  if (process.client && typeof plugin === 'function') {
    await plugin(app.context, inject);
  }

[codyrancher]

We probably want to inform the consumer if the schema doesn't exist instead of failing silently. I notice this pattern in other parts of this pr as well.

[codyrancher]

It's not obvious to me by looking at this signature how I should retrieve all items of a resource (from looking at the code it's obvious) which I think is problematic. Maybe changing options to filter instead would make that clear but I suspect we'll want to leave it as options to support pagination in the future.

I think I'd be in favor of splitting the functionality of findAll and findMatching/find into two different methods. If there's a better idea for making the usage obvious I'd be fine with something else.

[jordojordo]

I was trying to emulate how running a kubectl get <resource> would return all of a resource (sans the namespace), maybe this isn't the best approach. I figured having Intellisense that explains the design of the function and options in detail would provide clear instructions on how to use the method.

I'm open to splitting the functionality as well, this may help limit confusion with further implementation.

[codyrancher]

I have a suspicion we'll want to expose more of the methods from shell/store.index.js.

A few examples:
getCluster
getClusterId
isRancher

[jordojordo]

I decided not to dive too far into the weeds with implementation before we agreed on a proper plan of this API.