@appsemble/utils 0.20.8 → 0.20.11

package/api/components/schemas/ResourceDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResourceDefinition.js","sourceRoot":"","sources":["ResourceDefinition.ts"],"names":[],"mappings":";;;AAEA,MAAM,KAAK,GAAgC;IACzC,IAAI,EAAE,OAAO;IACb,WAAW,EAAE;;;CAGd;IACC,KAAK,EAAE;QACL,IAAI,EAAE,QAAQ;KACf;CACF,CAAC;AAEF,MAAM,KAAK,GAAmC;IAC5C,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,6CAA6C;IAC1D,oBAAoB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;CACzC,CAAC;AAEF,MAAM,eAAe,GAAmC;IACtD,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,MAAM;IACN,WAAW,EAAE,mBAAmB;IAChC,UAAU,EAAE;QACV,OAAO,EAAE;YACP,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAAE;YAC/C,QAAQ,EAAE,CAAC;YACX,WAAW,EAAE,IAAI;SAClB;KACF;CACF,CAAC;AAEW,QAAA,kBAAkB,GAAmC;IAChE,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,WAAW,EAAE,0CAA0C;IACvD,QAAQ,EAAE,CAAC,QAAQ,CAAC;IACpB,UAAU,EAAE;QACV,OAAO,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE;;;CAGlB;YACK,OAAO,EACL,gJAAgJ;iBAC7I,MAAM;SACZ;QACD,MAAM,EAAE;YACN,IAAI,EAAE,qCAAqC;YAC3C,WAAW,EAAE,sDAAsD;SACpE;QACD,UAAU,EAAE;YACV,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE;;;;CAIlB;YACK,aAAa,EAAE,CAAC;YAChB,oBAAoB,EAAE;gBACpB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,4CAA4C;gBACzD,oBAAoB,EAAE,KAAK;gBAC3B,UAAU,EAAE;oBACV,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBAC5B,MAAM,EAAE,eAAe;oBACvB,MAAM,EAAE,eAAe;oBACvB,MAAM,EAAE,eAAe;iBACxB;aACF;SACF;QACD,KAAK,EAAE;YACL,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,4DAA4D;YACzE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;SAC1B;QACD,GAAG,EAAE;YACH,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,8BAA8B;YACvC,WAAW,EAAE,wCAAwC;SACtD;QACD,EAAE,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,IAAI;YACb,WAAW,EAAE,0DAA0D;SACxE;QACD,OAAO,EAAE;YACP,WAAW,EAAE,8EAA8E;YAC3F,OAAO,EAAE,KAAK;YACd,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,SAAS;oBACf,WAAW,EACT,+FAA+F;iBAClG;gBACD,EAAE,IAAI,EAAE,gDAAgD,EAAE;aAC3D;SACF;QACD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,iCAAiC;YAC9C,oBAAoB,EAAE,KAAK;YAC3B,UAAU,EAAE;gBACV,KAAK;gBACL,KAAK;gBACL,MAAM,EAAE;oBACN,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,KAAK;oBACd,WAAW,EAAE,8CAA8C;iBAC5D;gBACD,GAAG,EAAE;oBACH,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,8BAA8B;oBACvC,WAAW,EAAE,sCAAsC;iBACpD;aACF;SACF;QACD,GAAG,EAAE;YACH,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,+BAA+B;YAC5C,oBAAoB,EAAE,KAAK;YAC3B,UAAU,EAAE;gBACV,KAAK;gBACL,KAAK;gBACL,MAAM,EAAE;oBACN,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,KAAK;oBACd,WAAW,EAAE,8CAA8C;iBAC5D;gBACD,GAAG,EAAE;oBACH,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,mCAAmC;oBAC5C,WAAW,EAAE,sCAAsC;iBACpD;aACF;SACF;QACD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,iCAAiC;YAC9C,oBAAoB,EAAE,KAAK;YAC3B,UAAU,EAAE;gBACV,KAAK;gBACL,KAAK;gBACL,MAAM,EAAE;oBACN,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,KAAK;oBACd,WAAW,EAAE,8CAA8C;iBAC5D;gBACD,GAAG,EAAE;oBACH,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,qCAAqC;oBAC9C,WAAW,EAAE,sCAAsC;iBACpD;aACF;SACF;QACD,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,kCAAkC;YAC/C,oBAAoB,EAAE,KAAK;YAC3B,UAAU,EAAE;gBACV,KAAK;gBACL,KAAK;gBACL,MAAM,EAAE;oBACN,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,MAAM;oBACf,WAAW,EAAE,8CAA8C;iBAC5D;gBACD,GAAG,EAAE;oBACH,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,mCAAmC;oBAC5C,WAAW,EAAE,sCAAsC;iBACpD;gBACD,KAAK,EAAE;oBACL,IAAI,EAAE,8CAA8C;iBACrD;aACF;SACF;QACD,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,kCAAkC;YAC/C,oBAAoB,EAAE,KAAK;YAC3B,UAAU,EAAE;gBACV,KAAK;gBACL,KAAK;gBACL,MAAM,EAAE;oBACN,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,KAAK;oBACd,WAAW,EAAE,8CAA8C;iBAC5D;gBACD,GAAG,EAAE;oBACH,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,mCAAmC;oBAC5C,WAAW,EAAE,sCAAsC;iBACpD;gBACD,KAAK,EAAE;oBACL,IAAI,EAAE,8CAA8C;iBACrD;aACF;SACF;QACD,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,kCAAkC;YAC/C,oBAAoB,EAAE,KAAK;YAC3B,UAAU,EAAE;gBACV,KAAK;gBACL,KAAK;gBACL,MAAM,EAAE;oBACN,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,QAAQ;oBACjB,WAAW,EAAE,8CAA8C;iBAC5D;gBACD,GAAG,EAAE;oBACH,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,mCAAmC;oBAC5C,WAAW,EAAE,sCAAsC;iBACpD;gBACD,KAAK,EAAE;oBACL,IAAI,EAAE,8CAA8C;iBACrD;aACF;SACF;QACD,KAAK,EAAE;YACL,IAAI,EAAE,6CAA6C;SACpD;KACF;CACF,CAAC"}

package/api/components/schemas/ResourceDefinition.ts

@@ -0,0 +1,229 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+const roles: OpenAPIV3.ArraySchemaObject = {
+  type: 'array',
+  description: `The list of roles that are allowed to use this action.
+
+This will override the default roles that are assigned.
+`,
+  items: {
+    type: 'string',
+  },
+};
+
+const query: OpenAPIV3.NonArraySchemaObject = {
+  type: 'object',
+  description: 'The query parameters to use in the request.',
+  additionalProperties: { type: 'string' },
+};
+
+const referenceAction: OpenAPIV3.NonArraySchemaObject = {
+  type: 'object',
+  additionalProperties: false,
+  // XXX
+  description: 'To be documented.',
+  properties: {
+    trigger: {
+      type: 'array',
+      items: { enum: ['create', 'update', 'delete'] },
+      minItems: 1,
+      uniqueItems: true,
+    },
+  },
+};
+
+export const ResourceDefinition: OpenAPIV3.NonArraySchemaObject = {
+  type: 'object',
+  additionalProperties: false,
+  description: 'A definition of how this resource works.',
+  required: ['schema'],
+  properties: {
+    expires: {
+      type: 'string',
+      description: `A time string representing when a resource should expire.
+
+Example: 1d 8h 30m
+`,
+      pattern:
+        /^(\d+(y|yr|years))?\s*(\d+months)?\s*(\d+(w|wk|weeks))?\s*(\d+(d|days))?\s*(\d+(h|hr|hours))?\s*(\d+(m|min|minutes))?\s*(\d+(s|sec|seconds))?$/
+          .source,
+    },
+    schema: {
+      $ref: '#/components/schemas/JSONSchemaRoot',
+      description: 'JSON schema definitions that may be used by the app.',
+    },
+    references: {
+      type: 'object',
+      description: `References to other resources.
+
+The key is the property that references the other resource. The value is an object describing the
+name of the resource and how it should behave.
+`,
+      minProperties: 1,
+      additionalProperties: {
+        type: 'object',
+        description: 'A reference to between two resource types.',
+        additionalProperties: false,
+        properties: {
+          resource: { type: 'string' },
+          create: referenceAction,
+          update: referenceAction,
+          delete: referenceAction,
+        },
+      },
+    },
+    roles: {
+      type: 'array',
+      description: 'The default roles that are allowed to perform all actions.',
+      items: { type: 'string' },
+    },
+    url: {
+      type: 'string',
+      default: '/api/apps/{appId}/{resource}',
+      description: 'URL to use if not otherwise specified.',
+    },
+    id: {
+      type: 'string',
+      default: 'id',
+      description: 'Name of the field used when accessing singular entities.',
+    },
+    history: {
+      description: 'A definition of how versioning should happen for instances of this resource.',
+      default: false,
+      oneOf: [
+        {
+          type: 'boolean',
+          description:
+            'Setting this to `true` is the same as using an object with the property `data` set to `true`.',
+        },
+        { $ref: '#/components/schemas/ResourceHistoryDefinition' },
+      ],
+    },
+    query: {
+      type: 'object',
+      description: "Overrides for 'query' requests.",
+      additionalProperties: false,
+      properties: {
+        roles,
+        query,
+        method: {
+          type: 'string',
+          default: 'GET',
+          description: 'HTTP method to use for this type of request.',
+        },
+        url: {
+          type: 'string',
+          default: '/api/apps/{appId}/{resource}',
+          description: 'URL to use for this type of request.',
+        },
+      },
+    },
+    get: {
+      type: 'object',
+      description: "Overrides for 'get' requests.",
+      additionalProperties: false,
+      properties: {
+        roles,
+        query,
+        method: {
+          type: 'string',
+          default: 'GET',
+          description: 'HTTP method to use for this type of request.',
+        },
+        url: {
+          type: 'string',
+          default: '/api/apps/{appId}/{resource}/{id}',
+          description: 'URL to use for this type of request.',
+        },
+      },
+    },
+    count: {
+      type: 'object',
+      description: "Overrides for 'count' requests.",
+      additionalProperties: false,
+      properties: {
+        roles,
+        query,
+        method: {
+          type: 'string',
+          default: 'GET',
+          description: 'HTTP method to use for this type of request.',
+        },
+        url: {
+          type: 'string',
+          default: '/api/apps/{appId}/{resource}/$count',
+          description: 'URL to use for this type of request.',
+        },
+      },
+    },
+    create: {
+      type: 'object',
+      description: "Overrides for 'create' requests.",
+      additionalProperties: false,
+      properties: {
+        roles,
+        query,
+        method: {
+          type: 'string',
+          default: 'POST',
+          description: 'HTTP method to use for this type of request.',
+        },
+        url: {
+          type: 'string',
+          default: '/api/apps/{appId}/{resource}/{id}',
+          description: 'URL to use for this type of request.',
+        },
+        hooks: {
+          $ref: '#/components/schemas/ResourceHooksDefinition',
+        },
+      },
+    },
+    update: {
+      type: 'object',
+      description: "Overrides for 'update' requests.",
+      additionalProperties: false,
+      properties: {
+        roles,
+        query,
+        method: {
+          type: 'string',
+          default: 'PUT',
+          description: 'HTTP method to use for this type of request.',
+        },
+        url: {
+          type: 'string',
+          default: '/api/apps/{appId}/{resource}/{id}',
+          description: 'URL to use for this type of request.',
+        },
+        hooks: {
+          $ref: '#/components/schemas/ResourceHooksDefinition',
+        },
+      },
+    },
+    delete: {
+      type: 'object',
+      description: "Overrides for 'delete' requests.",
+      additionalProperties: false,
+      properties: {
+        roles,
+        query,
+        method: {
+          type: 'string',
+          default: 'DELETE',
+          description: 'HTTP method to use for this type of request.',
+        },
+        url: {
+          type: 'string',
+          default: '/api/apps/{appId}/{resource}/{id}',
+          description: 'URL to use for this type of request.',
+        },
+        hooks: {
+          $ref: '#/components/schemas/ResourceHooksDefinition',
+        },
+      },
+    },
+    views: {
+      $ref: '#/components/schemas/ResourceViewDefinition',
+    },
+  },
+};

package/api/components/schemas/ResourceDeleteActionDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResourceDeleteActionDefinition.js","sourceRoot":"","sources":["ResourceDeleteActionDefinition.ts"],"names":[],"mappings":";;;AAAA,uEAAoE;AACpE,mCAA2C;AAE9B,QAAA,8BAA8B,GAAG,IAAA,wBAAgB,EAC5D,iDAAuB,EACvB;IACE,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC;IAC9B,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,iBAAiB,CAAC;YACzB,WAAW,EAAE,oBAAoB;SAClC;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,qCAAqC;SACnD;KACF;CACF,EACD,CAAC,KAAK,CAAC,CACR,CAAC"}

package/api/components/schemas/ResourceDeleteActionDefinition.ts

@@ -0,0 +1,22 @@
+import { RequestActionDefinition } from './RequestActionDefinition';
+import { extendJSONSchema } from './utils';
+
+export const ResourceDeleteActionDefinition = extendJSONSchema(
+  RequestActionDefinition,
+  {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type', 'resource'],
+    properties: {
+      type: {
+        enum: ['resource.delete'],
+        description: 'Delete a resource.',
+      },
+      resource: {
+        type: 'string',
+        description: 'The type of the resource to delete.',
+      },
+    },
+  },
+  ['url'],
+);

package/api/components/schemas/ResourceGetActionDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResourceGetActionDefinition.js","sourceRoot":"","sources":["ResourceGetActionDefinition.ts"],"names":[],"mappings":";;;AAAA,uEAAoE;AACpE,mCAA2C;AAE9B,QAAA,2BAA2B,GAAG,IAAA,wBAAgB,EACzD,iDAAuB,EACvB;IACE,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC;IAC9B,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,cAAc,CAAC;YACtB,WAAW,EAAE,wBAAwB;SACtC;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,kCAAkC;SAChD;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,mCAAmC;SACjD;KACF;CACF,EACD,CAAC,KAAK,CAAC,CACR,CAAC"}

package/api/components/schemas/ResourceGetActionDefinition.ts

@@ -0,0 +1,26 @@
+import { RequestActionDefinition } from './RequestActionDefinition';
+import { extendJSONSchema } from './utils';
+
+export const ResourceGetActionDefinition = extendJSONSchema(
+  RequestActionDefinition,
+  {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type', 'resource'],
+    properties: {
+      type: {
+        enum: ['resource.get'],
+        description: 'Get a single resource.',
+      },
+      resource: {
+        type: 'string',
+        description: 'The type of the resource to get.',
+      },
+      view: {
+        type: 'string',
+        description: 'The view to use for the resource.',
+      },
+    },
+  },
+  ['url'],
+);

package/api/components/schemas/ResourceHistoryDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResourceHistoryDefinition.js","sourceRoot":"","sources":["ResourceHistoryDefinition.ts"],"names":[],"mappings":";;;AAEa,QAAA,yBAAyB,GAAmC;IACvE,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,WAAW,EAAE,qEAAqE;IAClF,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,WAAW,EAAE,+EAA+E;SAC7F;KACF;CACF,CAAC"}

package/api/components/schemas/ResourceHistoryDefinition.ts

@@ -0,0 +1,15 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+export const ResourceHistoryDefinition: OpenAPIV3.NonArraySchemaObject = {
+  type: 'object',
+  additionalProperties: false,
+  description: 'A definition of how versioning works for instances of this resource',
+  required: ['data'],
+  properties: {
+    data: {
+      type: 'boolean',
+      default: true,
+      description: 'If set to `false`, edits are still tracked, but exactly what changed is lost.',
+    },
+  },
+};

package/api/components/schemas/ResourceHooksDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResourceHooksDefinition.js","sourceRoot":"","sources":["ResourceHooksDefinition.ts"],"names":[],"mappings":";;;AAEa,QAAA,uBAAuB,GAAmC;IACrE,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,0DAA0D;IACvE,oBAAoB,EAAE,KAAK;IAC3B,aAAa,EAAE,CAAC;IAChB,UAAU,EAAE;QACV,YAAY,EAAE,EAAE,IAAI,EAAE,iDAAiD,EAAE;KAC1E;CACF,CAAC"}

package/api/components/schemas/ResourceHooksDefinition.ts

@@ -0,0 +1,11 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+export const ResourceHooksDefinition: OpenAPIV3.NonArraySchemaObject = {
+  type: 'object',
+  description: 'Hooks that are triggered upon calling a resource action.',
+  additionalProperties: false,
+  minProperties: 1,
+  properties: {
+    notification: { $ref: '#/components/schemas/NotificationHookDefinition' },
+  },
+};

package/api/components/schemas/ResourceQueryActionDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResourceQueryActionDefinition.js","sourceRoot":"","sources":["ResourceQueryActionDefinition.ts"],"names":[],"mappings":";;;AAAA,uEAAoE;AACpE,mCAA2C;AAE9B,QAAA,6BAA6B,GAAG,IAAA,wBAAgB,EAC3D,iDAAuB,EACvB;IACE,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC;IAC9B,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,gBAAgB,CAAC;YACxB,WAAW,EAAE,4BAA4B;SAC1C;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,oCAAoC;SAClD;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,mCAAmC;SACjD;KACF;CACF,EACD,CAAC,KAAK,CAAC,CACR,CAAC"}

package/api/components/schemas/ResourceQueryActionDefinition.ts

@@ -0,0 +1,26 @@
+import { RequestActionDefinition } from './RequestActionDefinition';
+import { extendJSONSchema } from './utils';
+
+export const ResourceQueryActionDefinition = extendJSONSchema(
+  RequestActionDefinition,
+  {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type', 'resource'],
+    properties: {
+      type: {
+        enum: ['resource.query'],
+        description: 'Query a list of resources.',
+      },
+      resource: {
+        type: 'string',
+        description: 'The type of the resource to query.',
+      },
+      view: {
+        type: 'string',
+        description: 'The view to use for the resource.',
+      },
+    },
+  },
+  ['url'],
+);

package/api/components/schemas/ResourceSubscription.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResourceSubscription.js","sourceRoot":"","sources":["ResourceSubscription.ts"],"names":[],"mappings":";;;AAEa,QAAA,oBAAoB,GAAmC;IAClE,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,WAAW,EAAE,wDAAwD;IACrE,UAAU,EAAE;QACV,MAAM,EAAE;YACN,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,6EAA6E;SAC3F;QACD,MAAM,EAAE;YACN,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,6EAA6E;SAC3F;QACD,MAAM,EAAE;YACN,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,6EAA6E;SAC3F;QACD,aAAa,EAAE;YACb,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,gEAAgE;YAC7E,oBAAoB,EAAE;gBACpB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,0DAA0D;gBACvE,oBAAoB,EAAE,KAAK;gBAC3B,UAAU,EAAE;oBACV,MAAM,EAAE;wBACN,IAAI,EAAE,SAAS;wBACf,WAAW,EACT,gFAAgF;qBACnF;oBACD,MAAM,EAAE;wBACN,IAAI,EAAE,SAAS;wBACf,WAAW,EACT,8EAA8E;qBACjF;iBACF;aACF;SACF;KACF;CACF,CAAC"}

package/api/components/schemas/ResourceSubscription.ts

@@ -0,0 +1,42 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+export const ResourceSubscription: OpenAPIV3.NonArraySchemaObject = {
+  type: 'object',
+  additionalProperties: false,
+  description: 'This describes how a user is subscribed to a resource.',
+  properties: {
+    create: {
+      type: 'boolean',
+      description: 'If true, the user is subscribed to any create actions for the resource type',
+    },
+    update: {
+      type: 'boolean',
+      description: 'If true, the user is subscribed to any update actions for the resource type',
+    },
+    delete: {
+      type: 'boolean',
+      description: 'If true, the user is subscribed to any delete actions for the resource type',
+    },
+    subscriptions: {
+      type: 'object',
+      description: 'A mapping of resource IDs to individual resource subscriptions',
+      additionalProperties: {
+        type: 'object',
+        description: 'The subscription status of a user for a single resource.',
+        additionalProperties: false,
+        properties: {
+          update: {
+            type: 'boolean',
+            description:
+              'If true, the user is subscribed to update actions on this particular resource.',
+          },
+          delete: {
+            type: 'boolean',
+            description:
+              'If true, the user will be notified when this particular resource is deleted.',
+          },
+        },
+      },
+    },
+  },
+};

package/api/components/schemas/ResourceSubscriptionStatusActionDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResourceSubscriptionStatusActionDefinition.js","sourceRoot":"","sources":["ResourceSubscriptionStatusActionDefinition.ts"],"names":[],"mappings":";;;AAAA,iEAA8D;AAC9D,mCAA2C;AAE9B,QAAA,0CAA0C,GAAG,IAAA,wBAAgB,EAAC,2CAAoB,EAAE;IAC/F,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC;IAC9B,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,8BAA8B,CAAC;YACtC,WAAW,EACT,sGAAsG;SACzG;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,6DAA6D;SAC3E;QACD,MAAM,EAAE;YACN,IAAI,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC;YACpC,WAAW,EAAE,6DAA6D;SAC3E;KACF;CACF,CAAC,CAAC"}

package/api/components/schemas/ResourceSubscriptionStatusActionDefinition.ts

@@ -0,0 +1,23 @@
+import { BaseActionDefinition } from './BaseActionDefinition';
+import { extendJSONSchema } from './utils';
+
+export const ResourceSubscriptionStatusActionDefinition = extendJSONSchema(BaseActionDefinition, {
+  type: 'object',
+  additionalProperties: false,
+  required: ['type', 'resource'],
+  properties: {
+    type: {
+      enum: ['resource.subscription.status'],
+      description:
+        'Get the status of whether or not the user is subscriped to notifications for resource modifications.',
+    },
+    resource: {
+      type: 'string',
+      description: 'The type of the resource to get the subscription state for.',
+    },
+    action: {
+      enum: ['create', 'delete', 'update'],
+      description: 'The resource action type to get the subscription state for.',
+    },
+  },
+});

package/api/components/schemas/ResourceSubscriptionSubscribeActionDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResourceSubscriptionSubscribeActionDefinition.js","sourceRoot":"","sources":["ResourceSubscriptionSubscribeActionDefinition.ts"],"names":[],"mappings":";;;AAAA,iEAA8D;AAC9D,mCAA2C;AAE9B,QAAA,6CAA6C,GAAG,IAAA,wBAAgB,EAC3E,2CAAoB,EACpB;IACE,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC;IAC9B,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,iCAAiC,CAAC;YACzC,WAAW,EAAE,uDAAuD;SACrE;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,2CAA2C;SACzD;QACD,MAAM,EAAE;YACN,IAAI,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC;YACpC,WAAW,EAAE,2CAA2C;SACzD;KACF;CACF,CACF,CAAC"}

package/api/components/schemas/ResourceSubscriptionSubscribeActionDefinition.ts

@@ -0,0 +1,25 @@
+import { BaseActionDefinition } from './BaseActionDefinition';
+import { extendJSONSchema } from './utils';
+
+export const ResourceSubscriptionSubscribeActionDefinition = extendJSONSchema(
+  BaseActionDefinition,
+  {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type', 'resource'],
+    properties: {
+      type: {
+        enum: ['resource.subscription.subscribe'],
+        description: 'Subscribe to notifications on resource modifications.',
+      },
+      resource: {
+        type: 'string',
+        description: 'The type of the resource to subscribe to.',
+      },
+      action: {
+        enum: ['create', 'delete', 'update'],
+        description: 'The resource action type to subscribe to.',
+      },
+    },
+  },
+);

package/api/components/schemas/ResourceSubscriptionToggleActionDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResourceSubscriptionToggleActionDefinition.js","sourceRoot":"","sources":["ResourceSubscriptionToggleActionDefinition.ts"],"names":[],"mappings":";;;AAAA,iEAA8D;AAC9D,mCAA2C;AAE9B,QAAA,0CAA0C,GAAG,IAAA,wBAAgB,EAAC,2CAAoB,EAAE;IAC/F,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC;IAC9B,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,8BAA8B,CAAC;YACtC,WAAW,EAAE,2EAA2E;SACzF;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,gEAAgE;SAC9E;QACD,MAAM,EAAE;YACN,IAAI,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC;YACpC,WAAW,EAAE,gEAAgE;SAC9E;KACF;CACF,CAAC,CAAC"}

package/api/components/schemas/ResourceSubscriptionToggleActionDefinition.ts

@@ -0,0 +1,22 @@
+import { BaseActionDefinition } from './BaseActionDefinition';
+import { extendJSONSchema } from './utils';
+
+export const ResourceSubscriptionToggleActionDefinition = extendJSONSchema(BaseActionDefinition, {
+  type: 'object',
+  additionalProperties: false,
+  required: ['type', 'resource'],
+  properties: {
+    type: {
+      enum: ['resource.subscription.toggle'],
+      description: 'Toggle whether or not to receive notifications on resource modifications.',
+    },
+    resource: {
+      type: 'string',
+      description: 'The type of the resource to toggle the subscription state for.',
+    },
+    action: {
+      enum: ['create', 'delete', 'update'],
+      description: 'The resource action type to toggle the subscription state for.',
+    },
+  },
+});

package/api/components/schemas/ResourceSubscriptionUnsubscribeActionDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResourceSubscriptionUnsubscribeActionDefinition.js","sourceRoot":"","sources":["ResourceSubscriptionUnsubscribeActionDefinition.ts"],"names":[],"mappings":";;;AAAA,iEAA8D;AAC9D,mCAA2C;AAE9B,QAAA,+CAA+C,GAAG,IAAA,wBAAgB,EAC7E,2CAAoB,EACpB;IACE,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC;IAC9B,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,mCAAmC,CAAC;YAC3C,WAAW,EAAE,2DAA2D;SACzE;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,+CAA+C;SAC7D;QACD,MAAM,EAAE;YACN,IAAI,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC;YACpC,WAAW,EAAE,+CAA+C;SAC7D;KACF;CACF,CACF,CAAC"}

package/api/components/schemas/ResourceSubscriptionUnsubscribeActionDefinition.ts

@@ -0,0 +1,25 @@
+import { BaseActionDefinition } from './BaseActionDefinition';
+import { extendJSONSchema } from './utils';
+
+export const ResourceSubscriptionUnsubscribeActionDefinition = extendJSONSchema(
+  BaseActionDefinition,
+  {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type', 'resource'],
+    properties: {
+      type: {
+        enum: ['resource.subscription.unsubscribe'],
+        description: 'Unsubscribe from notifications on resource modifications.',
+      },
+      resource: {
+        type: 'string',
+        description: 'The type of the resource to unsubscribe from.',
+      },
+      action: {
+        enum: ['create', 'delete', 'update'],
+        description: 'The resource action type to unsubscribe from.',
+      },
+    },
+  },
+);

package/api/components/schemas/ResourceUpdateActionDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResourceUpdateActionDefinition.js","sourceRoot":"","sources":["ResourceUpdateActionDefinition.ts"],"names":[],"mappings":";;;AAAA,uEAAoE;AACpE,mCAA2C;AAE9B,QAAA,8BAA8B,GAAG,IAAA,wBAAgB,EAC5D,iDAAuB,EACvB;IACE,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC;IAC9B,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,iBAAiB,CAAC;YACzB,WAAW,EAAE,oBAAoB;SAClC;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,oCAAoC;SAClD;KACF;CACF,EACD,CAAC,KAAK,CAAC,CACR,CAAC"}

package/api/components/schemas/ResourceUpdateActionDefinition.ts

@@ -0,0 +1,22 @@
+import { RequestActionDefinition } from './RequestActionDefinition';
+import { extendJSONSchema } from './utils';
+
+export const ResourceUpdateActionDefinition = extendJSONSchema(
+  RequestActionDefinition,
+  {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type', 'resource'],
+    properties: {
+      type: {
+        enum: ['resource.update'],
+        description: 'Update a resource.',
+      },
+      resource: {
+        type: 'string',
+        description: 'The type of the resource to query.',
+      },
+    },
+  },
+  ['url'],
+);

package/api/components/schemas/ResourceViewDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResourceViewDefinition.js","sourceRoot":"","sources":["ResourceViewDefinition.ts"],"names":[],"mappings":";;;AAEa,QAAA,sBAAsB,GAAmC;IACpE,IAAI,EAAE,QAAQ;IACd,aAAa,EAAE,CAAC;IAChB,WAAW,EACT,wGAAwG;IAC1G,oBAAoB,EAAE;QACpB,IAAI,EAAE,QAAQ;QACd,oBAAoB,EAAE,KAAK;QAC3B,WAAW,EAAE,+BAA+B;QAC5C,UAAU,EAAE;YACV,KAAK,EAAE;gBACL,IAAI,EAAE,OAAO;gBACb,WAAW,EAAE,sDAAsD;gBACnE,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;iBACf;aACF;YACD,KAAK,EAAE;gBACL,IAAI,EAAE,yCAAyC;gBAC/C,WAAW,EAAE,oBAAoB;aAClC;SACF;KACF;CACF,CAAC"}

package/api/components/schemas/ResourceViewDefinition.ts

@@ -0,0 +1,26 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+export const ResourceViewDefinition: OpenAPIV3.NonArraySchemaObject = {
+  type: 'object',
+  minProperties: 1,
+  description:
+    'Alternative views of a resource that are modified using remappers and support different sets of roles.',
+  additionalProperties: {
+    type: 'object',
+    additionalProperties: false,
+    description: 'A custom view for a resource.',
+    properties: {
+      roles: {
+        type: 'array',
+        description: 'The list of roles that are allowed to use this view.',
+        items: {
+          type: 'string',
+        },
+      },
+      remap: {
+        $ref: '#/components/schemas/RemapperDefinition',
+        description: 'The modified view.',
+      },
+    },
+  },
+};