Class StaticCapabilities

constructor

• new StaticCapabilities(): StaticCapabilities

  Returns StaticCapabilities

Staticannotation

StaticoutgoingTypes

Staticpermissions

Staticschema

Staticis

• is(
      input: unknown,
  ): input is {
      compute: { memory: number; timeout: number };
      description: string;
      invocations: {
          incoming?: {
              schedule?: {
                  default: { enabled: boolean; schedule: string };
                  description: string;
              };
              webhook?: { default: { enabled: boolean }; description: string };
          };
          outgoing?: { types: { description: string; resource: string }[] };
      };
      name: string;
      permissions: { description: string; required: boolean; resource: string }[];
      version: string;
  }

  Parameters

  • input: unknown

  Returns input is {
      compute: { memory: number; timeout: number };
      description: string;
      invocations: {
          incoming?: {
              schedule?: {
                  default: { enabled: boolean; schedule: string };
                  description: string;
              };
              webhook?: { default: { enabled: boolean }; description: string };
          };
          outgoing?: { types: { description: string; resource: string }[] };
      };
      name: string;
      permissions: { description: string; required: boolean; resource: string }[];
      version: string;
  }

StaticisSubscribedOutgoingType

• isSubscribedOutgoingType(subscriptions: string[], resource: string): boolean

  Is a concrete <resource>:<action> string covered by any entry of a list of declared or subscribed Outgoing types

  Parameters

  • subscriptions: string[]
  • resource: string

  Returns boolean

StaticisValidOutgoingType

• isValidOutgoingType(resource: string): boolean

  Ensure a <resource>:<action> string refers to a known Outgoing resource type and an action it can be subscribed at - <resource>:* is valid for every resource type

  Parameters

  • resource: string

  Returns boolean

StaticisValidPermission

• isValidPermission(resource: string): boolean

  Ensure a <permission>:<level> string refers to a known permission and a level it can be granted at - <permission>:* is valid for every permission

  Parameters

  • resource: string

  Returns boolean

StaticmatchesOutgoingType

• matchesOutgoingType(declared: string, resource: string): boolean

  Does a declared or subscribed Outgoing type (which may carry a wildcard action) cover a concrete <resource>:<action> string

  Parameters

  • declared: string
  • resource: string

  Returns boolean

Staticread

• read(
      path: string | URL,
  ): Promise<
      | {
          compute: { memory: number; timeout: number };
          description: string;
          invocations: {
              incoming?: {
                  schedule?: {
                      default: { enabled: boolean; schedule: string };
                      description: string;
                  };
                  webhook?: { default: { enabled: boolean }; description: string };
              };
              outgoing?: { types: { description: string; resource: string }[] };
          };
          name: string;
          permissions: { description: string; required: boolean; resource: string }[];
          version: string;
      }
      | null,
  >

  Read and validate a capabilities.json document from disk, returning null if no document exists at the given path

  Parameters

  • path: string | URL

  Returns Promise<
      | {
          compute: { memory: number; timeout: number };
          description: string;
          invocations: {
              incoming?: {
                  schedule?: {
                      default: { enabled: boolean; schedule: string };
                      description: string;
                  };
                  webhook?: { default: { enabled: boolean }; description: string };
              };
              outgoing?: { types: { description: string; resource: string }[] };
          };
          name: string;
          permissions: { description: string; required: boolean; resource: string }[];
          version: string;
      }
      | null,
  >

Staticvalidate

• validate(
      input: unknown,
  ): {
      compute: { memory: number; timeout: number };
      description: string;
      invocations: {
          incoming?: {
              schedule?: {
                  default: { enabled: boolean; schedule: string };
                  description: string;
              };
              webhook?: { default: { enabled: boolean }; description: string };
          };
          outgoing?: { types: { description: string; resource: string }[] };
      };
      name: string;
      permissions: { description: string; required: boolean; resource: string }[];
      version: string;
  }

  Parameters

  • input: unknown

  Returns {
      compute: { memory: number; timeout: number };
      description: string;
      invocations: {
          incoming?: {
              schedule?: {
                  default: { enabled: boolean; schedule: string };
                  description: string;
              };
              webhook?: { default: { enabled: boolean }; description: string };
          };
          outgoing?: { types: { description: string; resource: string }[] };
      };
      name: string;
      permissions: { description: string; required: boolean; resource: string }[];
      version: string;
  }