@appsemble/utils 0.20.9 → 0.20.12

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

@@ -0,0 +1 @@
+{"version":3,"file":"SSOConfiguration.js","sourceRoot":"","sources":["SSOConfiguration.ts"],"names":[],"mappings":";;;AAEa,QAAA,gBAAgB,GAAmC;IAC9D,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,2DAA2D;IACxE,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACV,GAAG,EAAE;YACH,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,2DAA2D;SACzE;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,6CAA6C;SAC3D;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,sBAAsB;SACpC;KACF;CACF,CAAC"}

package/api/components/schemas/SSOConfiguration.ts

@@ -0,0 +1,22 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+export const SSOConfiguration: OpenAPIV3.NonArraySchemaObject = {
+  type: 'object',
+  description: 'A single sign on configuration which is exposed to users.',
+  additionalProperties: false,
+  properties: {
+    url: {
+      type: 'string',
+      format: 'url',
+      description: 'The URL users will be redirected to in the login process.',
+    },
+    name: {
+      type: 'string',
+      description: 'A user readable name for the configuration.',
+    },
+    icon: {
+      type: 'string',
+      description: 'A Font Awesome icon.',
+    },
+  },
+};

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

@@ -0,0 +1 @@
+{"version":3,"file":"SecurityDefaultDefinition.js","sourceRoot":"","sources":["SecurityDefaultDefinition.ts"],"names":[],"mappings":";;;AAEa,QAAA,yBAAyB,GAAmC;IACvE,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,WAAW,EAAE,uCAAuC;IACpD,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACV,MAAM,EAAE;YACN,IAAI,EAAE,CAAC,UAAU,EAAE,cAAc,EAAE,QAAQ,CAAC;YAC5C,OAAO,EAAE,UAAU;YACnB,WAAW,EAAE;;;;;;CAMlB;SACI;QAED,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE;;;CAGlB;SACI;KACF;CACF,CAAC"}

package/api/components/schemas/SecurityDefaultDefinition.ts

@@ -0,0 +1,29 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+export const SecurityDefaultDefinition: OpenAPIV3.NonArraySchemaObject = {
+  type: 'object',
+  required: ['role'],
+  description: 'The default role to apply to members.',
+  additionalProperties: false,
+  properties: {
+    policy: {
+      enum: ['everyone', 'organization', 'invite'],
+      default: 'everyone',
+      description: `How the \`default\` role gets applied to users.
+
+The following values are allowed:
+- \`everyone\`: Every authenticated user gets the default role.
+- \`organization\`: Every authenticated user gets the default role if they are in the same organization as the app.
+- \`invite\`: The user has to manually get a role assigned.
+`,
+    },
+
+    role: {
+      type: 'string',
+      description: `The default role to apply to members.
+
+This must match with one of the roles defined within the security definition.
+`,
+    },
+  },
+};

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

@@ -0,0 +1 @@
+{"version":3,"file":"SecurityDefinition.js","sourceRoot":"","sources":["SecurityDefinition.ts"],"names":[],"mappings":";;;AAEa,QAAA,kBAAkB,GAAmC;IAChE,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,wCAAwC;IACrD,QAAQ,EAAE,CAAC,SAAS,EAAE,OAAO,CAAC;IAC9B,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACV,OAAO,EAAE,EAAE,IAAI,EAAE,gDAAgD,EAAE;QACnE,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,yEAAyE;YACtF,aAAa,EAAE,CAAC;YAChB,oBAAoB,EAAE,EAAE,IAAI,EAAE,6CAA6C,EAAE;SAC9E;QACD,KAAK,EAAE;YACL,IAAI,EAAE,sCAAsC;YAC5C,WAAW,EAAE,0CAA0C;SACxD;KACF;CACF,CAAC"}

package/api/components/schemas/SecurityDefinition.ts

@@ -0,0 +1,21 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+export const SecurityDefinition: OpenAPIV3.NonArraySchemaObject = {
+  type: 'object',
+  description: 'This describes how the app is secured.',
+  required: ['default', 'roles'],
+  additionalProperties: false,
+  properties: {
+    default: { $ref: '#/components/schemas/SecurityDefaultDefinition' },
+    roles: {
+      type: 'object',
+      description: 'This property defines the user roles that are available within the app.',
+      minProperties: 1,
+      additionalProperties: { $ref: '#/components/schemas/SecurityRoleDefinition' },
+    },
+    teams: {
+      $ref: '#/components/schemas/TeamsDefinition',
+      description: 'Define how teams are handled by the app.',
+    },
+  },
+};

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

@@ -0,0 +1 @@
+{"version":3,"file":"SecurityRoleDefinition.js","sourceRoot":"","sources":["SecurityRoleDefinition.ts"],"names":[],"mappings":";;;AAEa,QAAA,sBAAsB,GAAmC;IACpE,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,iCAAiC;IAC9C,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACV,WAAW,EAAE;YACX,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,8BAA8B;SAC5C;QACD,WAAW,EAAE;YACX,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,uDAAuD;SACrE;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,CAAC;YACX,WAAW,EAAE;;;;CAIlB;YACK,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;aACf;SACF;KACF;CACF,CAAC"}

package/api/components/schemas/SecurityRoleDefinition.ts

@@ -0,0 +1,29 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+export const SecurityRoleDefinition: OpenAPIV3.NonArraySchemaObject = {
+  type: 'object',
+  description: 'This describes a security role.',
+  additionalProperties: false,
+  properties: {
+    description: {
+      type: 'string',
+      description: 'The description of the role.',
+    },
+    defaultPage: {
+      type: 'string',
+      description: 'The default page to redirect users with this role to.',
+    },
+    inherits: {
+      type: 'array',
+      minItems: 1,
+      description: `The name of the role to inherit from.
+
+Note that this role must exist and can not inherit itself via this field or the \`inherits\` field
+of the referenced role.
+`,
+      items: {
+        type: 'string',
+      },
+    },
+  },
+};

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

@@ -0,0 +1 @@
+{"version":3,"file":"ShareActionDefinition.js","sourceRoot":"","sources":["ShareActionDefinition.ts"],"names":[],"mappings":";;;AAAA,iEAA8D;AAC9D,mCAA2C;AAE9B,QAAA,qBAAqB,GAAG,IAAA,wBAAgB,EAAC,2CAAoB,EAAE;IAC1E,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,OAAO,CAAC;YACf,WAAW,EAAE;;;;CAIlB;SACI;QACD,GAAG,EAAE;YACH,IAAI,EAAE,yCAAyC;YAC/C,WAAW,EAAE,+BAA+B;SAC7C;QACD,KAAK,EAAE;YACL,IAAI,EAAE,yCAAyC;YAC/C,WAAW,EAAE,kCAAkC;SAChD;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,yCAAyC;YAC/C,WAAW,EAAE,sCAAsC;SACpD;KACF;CACF,CAAC,CAAC"}

package/api/components/schemas/ShareActionDefinition.ts

@@ -0,0 +1,30 @@
+import { BaseActionDefinition } from './BaseActionDefinition';
+import { extendJSONSchema } from './utils';
+
+export const ShareActionDefinition = extendJSONSchema(BaseActionDefinition, {
+  type: 'object',
+  additionalProperties: false,
+  required: ['type'],
+  properties: {
+    type: {
+      enum: ['share'],
+      description: `The \`share\` action can be used to display a prompt that allows the user to share something with others, primarily via social media.
+
+Depending on whether the user’s browser supports a native share function it will either display a
+native dialog for sharing links, or display a more limited fallback in a dialog.
+`,
+    },
+    url: {
+      $ref: '#/components/schemas/RemapperDefinition',
+      description: 'The url that is being shared.',
+    },
+    title: {
+      $ref: '#/components/schemas/RemapperDefinition',
+      description: 'The title that should be shared.',
+    },
+    text: {
+      $ref: '#/components/schemas/RemapperDefinition',
+      description: 'The main body that should be shared.',
+    },
+  },
+});

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

@@ -0,0 +1 @@
+{"version":3,"file":"StaticActionDefinition.js","sourceRoot":"","sources":["StaticActionDefinition.ts"],"names":[],"mappings":";;;AAAA,iEAA8D;AAC9D,mCAA2C;AAE9B,QAAA,sBAAsB,GAAG,IAAA,wBAAgB,EAAC,2CAAoB,EAAE;IAC3E,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;IAC3B,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,QAAQ,CAAC;YAChB,WAAW,EAAE;;;CAGlB;SACI;QACD,KAAK,EAAE;YACL,WAAW,EAAE,6BAA6B;SAC3C;KACF;CACF,CAAC,CAAC"}

package/api/components/schemas/StaticActionDefinition.ts

@@ -0,0 +1,20 @@
+import { BaseActionDefinition } from './BaseActionDefinition';
+import { extendJSONSchema } from './utils';
+
+export const StaticActionDefinition = extendJSONSchema(BaseActionDefinition, {
+  type: 'object',
+  additionalProperties: false,
+  required: ['type', 'value'],
+  properties: {
+    type: {
+      enum: ['static'],
+      description: `The \`static\` action returns static data defined in the action definition.
+
+This is useful for example for stubbing data.
+`,
+    },
+    value: {
+      description: 'The static value to return.',
+    },
+  },
+});

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

@@ -0,0 +1 @@
+{"version":3,"file":"StorageReadActionDefinition.js","sourceRoot":"","sources":["StorageReadActionDefinition.ts"],"names":[],"mappings":";;;AAAA,iEAA8D;AAC9D,mCAA2C;AAE9B,QAAA,2BAA2B,GAAG,IAAA,wBAAgB,EAAC,2CAAoB,EAAE;IAChF,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC;IACzB,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,cAAc,CAAC;YACtB,WAAW,EAAE,yCAAyC;SACvD;QACD,GAAG,EAAE;YACH,IAAI,EAAE,yCAAyC;YAC/C,WAAW,EAAE,+BAA+B;SAC7C;QACD,OAAO,EAAE;YACP,IAAI,EAAE,CAAC,WAAW,EAAE,cAAc,EAAE,gBAAgB,CAAC;YACrD,WAAW,EAAE,2CAA2C;YACxD,OAAO,EAAE,WAAW;SACrB;KACF;CACF,CAAC,CAAC"}

package/api/components/schemas/StorageReadActionDefinition.ts

@@ -0,0 +1,23 @@
+import { BaseActionDefinition } from './BaseActionDefinition';
+import { extendJSONSchema } from './utils';
+
+export const StorageReadActionDefinition = extendJSONSchema(BaseActionDefinition, {
+  type: 'object',
+  additionalProperties: false,
+  required: ['type', 'key'],
+  properties: {
+    type: {
+      enum: ['storage.read'],
+      description: 'Read data from the app’s local storage.',
+    },
+    key: {
+      $ref: '#/components/schemas/RemapperDefinition',
+      description: 'The key of the storage entry.',
+    },
+    storage: {
+      enum: ['indexedDB', 'localStorage', 'sessionStorage'],
+      description: 'The mechanism used to read the data from.',
+      default: 'indexedDB',
+    },
+  },
+});

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

@@ -0,0 +1 @@
+{"version":3,"file":"StorageWriteActionDefinition.js","sourceRoot":"","sources":["StorageWriteActionDefinition.ts"],"names":[],"mappings":";;;AAAA,iEAA8D;AAC9D,mCAA2C;AAE9B,QAAA,4BAA4B,GAAG,IAAA,wBAAgB,EAAC,2CAAoB,EAAE;IACjF,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC;IAClC,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,eAAe,CAAC;YACvB,WAAW,EAAE,wCAAwC;SACtD;QACD,GAAG,EAAE;YACH,IAAI,EAAE,yCAAyC;YAC/C,WAAW,EAAE,+BAA+B;SAC7C;QACD,KAAK,EAAE;YACL,IAAI,EAAE,yCAAyC;YAC/C,WAAW,EAAE,yCAAyC;SACvD;QACD,OAAO,EAAE;YACP,IAAI,EAAE,CAAC,WAAW,EAAE,cAAc,EAAE,gBAAgB,CAAC;YACrD,WAAW,EAAE,uCAAuC;YACpD,OAAO,EAAE,WAAW;SACrB;KACF;CACF,CAAC,CAAC"}

package/api/components/schemas/StorageWriteActionDefinition.ts

@@ -0,0 +1,27 @@
+import { BaseActionDefinition } from './BaseActionDefinition';
+import { extendJSONSchema } from './utils';
+
+export const StorageWriteActionDefinition = extendJSONSchema(BaseActionDefinition, {
+  type: 'object',
+  additionalProperties: false,
+  required: ['type', 'key', 'value'],
+  properties: {
+    type: {
+      enum: ['storage.write'],
+      description: 'Write data to the app’s local storage.',
+    },
+    key: {
+      $ref: '#/components/schemas/RemapperDefinition',
+      description: 'The key of the storage entry.',
+    },
+    value: {
+      $ref: '#/components/schemas/RemapperDefinition',
+      description: 'The data to write to the storage entry.',
+    },
+    storage: {
+      enum: ['indexedDB', 'localStorage', 'sessionStorage'],
+      description: 'The mechanism used to store the data.',
+      default: 'indexedDB',
+    },
+  },
+});

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

@@ -0,0 +1 @@
+{"version":3,"file":"SubPage.js","sourceRoot":"","sources":["SubPage.ts"],"names":[],"mappings":";;;AAEa,QAAA,OAAO,GAAmC;IACrD,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,2DAA2D;IACxE,QAAQ,EAAE,CAAC,QAAQ,CAAC;IACpB,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,2BAA2B;YACxC,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,EAAE;SACd;QACD,MAAM,EAAE;YACN,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,CAAC;YACX,WAAW,EAAE,iCAAiC;YAC9C,KAAK,EAAE;gBACL,IAAI,EAAE,sCAAsC;aAC7C;SACF;KACF;CACF,CAAC"}

package/api/components/schemas/SubPage.ts

@@ -0,0 +1,24 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+export const SubPage: OpenAPIV3.NonArraySchemaObject = {
+  type: 'object',
+  description: 'This describes what a sub page will look like in the app.',
+  required: ['blocks'],
+  additionalProperties: false,
+  properties: {
+    name: {
+      type: 'string',
+      description: 'The name of the sub page.',
+      minLength: 1,
+      maxLength: 50,
+    },
+    blocks: {
+      type: 'array',
+      minItems: 1,
+      description: 'The blocks that make up a page.',
+      items: {
+        $ref: '#/components/schemas/BlockDefinition',
+      },
+    },
+  },
+};

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

@@ -0,0 +1 @@
+{"version":3,"file":"TabsPageDefinition.js","sourceRoot":"","sources":["TabsPageDefinition.ts"],"names":[],"mappings":";;;AAAA,6DAA0D;AAC1D,mCAA2C;AAE9B,QAAA,kBAAkB,GAAG,IAAA,wBAAgB,EAAC,uCAAkB,EAAE;IACrE,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,uDAAuD;IACpE,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;IAC1B,oBAAoB,EAAE,IAAI;IAC1B,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,MAAM,CAAC;SACf;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,CAAC;YACX,WAAW,EAAE,+CAA+C;YAC5D,KAAK,EAAE;gBACL,IAAI,EAAE,8BAA8B;aACrC;SACF;KACF;CACF,CAAC,CAAC"}

package/api/components/schemas/TabsPageDefinition.ts

@@ -0,0 +1,22 @@
+import { BasePageDefinition } from './BasePageDefinition';
+import { extendJSONSchema } from './utils';
+
+export const TabsPageDefinition = extendJSONSchema(BasePageDefinition, {
+  type: 'object',
+  description: 'This describes what a page will look like in the app.',
+  required: ['type', 'tabs'],
+  additionalProperties: true,
+  properties: {
+    type: {
+      enum: ['tabs'],
+    },
+    tabs: {
+      type: 'array',
+      minItems: 1,
+      description: 'Each of the available tabs for the tabs page.',
+      items: {
+        $ref: '#/components/schemas/SubPage',
+      },
+    },
+  },
+});

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

@@ -0,0 +1 @@
+{"version":3,"file":"TeamInviteActionDefinition.js","sourceRoot":"","sources":["TeamInviteActionDefinition.ts"],"names":[],"mappings":";;;AAAA,iEAA8D;AAC9D,mCAA2C;AAE9B,QAAA,0BAA0B,GAAG,IAAA,wBAAgB,EAAC,2CAAoB,EAAE;IAC/E,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,aAAa,CAAC;YACrB,WAAW,EAAE,wCAAwC;SACtD;QACD,EAAE,EAAE;YACF,WAAW,EAAE,2CAA2C;YACxD,IAAI,EAAE,yCAAyC;SAChD;QACD,KAAK,EAAE;YACL,WAAW,EAAE,0CAA0C;YACvD,IAAI,EAAE,yCAAyC;SAChD;QACD,IAAI,EAAE;YACJ,WAAW,EAAE,iCAAiC;YAC9C,IAAI,EAAE,yCAAyC;YAC/C,OAAO,EAAE,QAAQ;SAClB;KACF;CACF,CAAC,CAAC"}

package/api/components/schemas/TeamInviteActionDefinition.ts

@@ -0,0 +1,27 @@
+import { BaseActionDefinition } from './BaseActionDefinition';
+import { extendJSONSchema } from './utils';
+
+export const TeamInviteActionDefinition = extendJSONSchema(BaseActionDefinition, {
+  type: 'object',
+  additionalProperties: false,
+  required: ['type'],
+  properties: {
+    type: {
+      enum: ['team.invite'],
+      description: 'Get a list of all of the user’s teams.',
+    },
+    id: {
+      description: 'The ID of the team to invite the user to.',
+      $ref: '#/components/schemas/RemapperDefinition',
+    },
+    email: {
+      description: 'The email address of the user to invite.',
+      $ref: '#/components/schemas/RemapperDefinition',
+    },
+    role: {
+      description: 'The role to invite the user as.',
+      $ref: '#/components/schemas/RemapperDefinition',
+      default: 'member',
+    },
+  },
+});

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

@@ -0,0 +1 @@
+{"version":3,"file":"TeamJoinActionDefinition.js","sourceRoot":"","sources":["TeamJoinActionDefinition.ts"],"names":[],"mappings":";;;AAAA,iEAA8D;AAC9D,mCAA2C;AAE9B,QAAA,wBAAwB,GAAG,IAAA,wBAAgB,EAAC,2CAAoB,EAAE;IAC7E,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,WAAW,CAAC;YACnB,WAAW,EAAE,wCAAwC;SACtD;KACF;CACF,CAAC,CAAC"}

package/api/components/schemas/TeamJoinActionDefinition.ts

@@ -0,0 +1,14 @@
+import { BaseActionDefinition } from './BaseActionDefinition';
+import { extendJSONSchema } from './utils';
+
+export const TeamJoinActionDefinition = extendJSONSchema(BaseActionDefinition, {
+  type: 'object',
+  additionalProperties: false,
+  required: ['type'],
+  properties: {
+    type: {
+      enum: ['team.join'],
+      description: 'Get a list of all of the user’s teams.',
+    },
+  },
+});

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

@@ -0,0 +1 @@
+{"version":3,"file":"TeamListActionDefinition.js","sourceRoot":"","sources":["TeamListActionDefinition.ts"],"names":[],"mappings":";;;AAAA,iEAA8D;AAC9D,mCAA2C;AAE9B,QAAA,wBAAwB,GAAG,IAAA,wBAAgB,EAAC,2CAAoB,EAAE;IAC7E,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,WAAW,CAAC;YACnB,WAAW,EAAE,wCAAwC;SACtD;KACF;CACF,CAAC,CAAC"}

package/api/components/schemas/TeamListActionDefinition.ts

@@ -0,0 +1,14 @@
+import { BaseActionDefinition } from './BaseActionDefinition';
+import { extendJSONSchema } from './utils';
+
+export const TeamListActionDefinition = extendJSONSchema(BaseActionDefinition, {
+  type: 'object',
+  additionalProperties: false,
+  required: ['type'],
+  properties: {
+    type: {
+      enum: ['team.list'],
+      description: 'Get a list of all of the user’s teams.',
+    },
+  },
+});

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

@@ -0,0 +1 @@
+{"version":3,"file":"TeamsDefinition.js","sourceRoot":"","sources":["TeamsDefinition.ts"],"names":[],"mappings":";;;AAEa,QAAA,eAAe,GAAmC;IAC7D,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,WAAW,EAAE,+CAA+C;IAC5D,QAAQ,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC;IAC5B,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC;YAC1B,WAAW,EACT,wIAAwI;SAC3I;QACD,MAAM,EAAE;YACN,IAAI,EAAE,OAAO;YACb,WAAW,EAAE;;4DAEyC;YACtD,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YACzB,OAAO,EAAE,EAAE;SACZ;QACD,MAAM,EAAE;YACN,IAAI,EAAE,OAAO;YACb,WAAW,EAAE;;oJAEiI;YAC9I,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;SAC1B;KACF;CACF,CAAC"}

package/api/components/schemas/TeamsDefinition.ts

@@ -0,0 +1,30 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+export const TeamsDefinition: OpenAPIV3.NonArraySchemaObject = {
+  type: 'object',
+  additionalProperties: false,
+  description: 'This defines how teams are handled by an app.',
+  required: ['join', 'invite'],
+  properties: {
+    join: {
+      enum: ['anyone', 'invite'],
+      description:
+        'If this is set to `anyone`, any logged in user may join a team. If this is set to `invite`, only users may join who have been invited.',
+    },
+    create: {
+      type: 'array',
+      description: `A list of app roles which may create a team.
+
+By default teams can only be created from Appsemble Studio.`,
+      items: { type: 'string' },
+      default: [],
+    },
+    invite: {
+      type: 'array',
+      description: `The roles here determine which users may invite a team member.
+
+The special roles \`$team:member\` and \`$team:manager\` mean that users who are already member of manager of the team may also invite new members.`,
+      items: { type: 'string' },
+    },
+  },
+};

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

@@ -0,0 +1 @@
+{"version":3,"file":"Theme.js","sourceRoot":"","sources":["Theme.ts"],"names":[],"mappings":";;;AAEA,kDAAyD;AAE5C,QAAA,KAAK,GAAmC;IACnD,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,6BAA6B;IAC1C,oBAAoB,EAAE,KAAK;IAC3B,aAAa,EAAE,CAAC;IAChB,UAAU,EAAE;QACV,UAAU,EAAE;YACV,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,oBAAQ,CAAC,MAAM;YACxB,OAAO,EAAE,qBAAS,CAAC,UAAU;YAC7B,WAAW,EAAE;;;CAGlB;SACI;QACD,WAAW,EAAE;YACX,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,oBAAQ,CAAC,MAAM;YACxB,OAAO,EAAE,qBAAS,CAAC,WAAW;YAC9B,WAAW,EAAE;;;CAGlB;SACI;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,oBAAQ,CAAC,MAAM;YACxB,OAAO,EAAE,qBAAS,CAAC,YAAY;YAC/B,WAAW,EAAE;;;CAGlB;SACI;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,oBAAQ,CAAC,MAAM;YACxB,OAAO,EAAE,qBAAS,CAAC,SAAS;YAC5B,WAAW,EAAE,2BAA2B;SACzC;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,oBAAQ,CAAC,MAAM;YACxB,OAAO,EAAE,qBAAS,CAAC,SAAS;YAC5B,WAAW,EAAE,4CAA4C;SAC1D;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,oBAAQ,CAAC,MAAM;YACxB,OAAO,EAAE,qBAAS,CAAC,YAAY;YAC/B,WAAW,EAAE,wCAAwC;SACtD;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,oBAAQ,CAAC,MAAM;YACxB,OAAO,EAAE,qBAAS,CAAC,YAAY;YAC/B,WAAW,EAAE,sCAAsC;SACpD;QACD,WAAW,EAAE;YACX,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,oBAAQ,CAAC,MAAM;YACxB,OAAO,EAAE,qBAAS,CAAC,WAAW;YAC9B,WAAW,EAAE,oCAAoC;SAClD;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,qBAAS,CAAC,SAAS;YAC5B,WAAW,EAAE,wCAAwC;SACtD;QACD,IAAI,EAAE;YACJ,WAAW,EAAE,6BAA6B;YAC1C,KAAK,EAAE;gBACL,EAAE,IAAI,EAAE,2CAA2C,EAAE;gBACrD,EAAE,IAAI,EAAE,2CAA2C,EAAE;aACtD;SACF;KACF;CACF,CAAC"}

package/api/components/schemas/Theme.ts

@@ -0,0 +1,82 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+import { baseTheme, hexColor } from '../../../constants';
+
+export const Theme: OpenAPIV3.NonArraySchemaObject = {
+  type: 'object',
+  description: 'A generic theme definition.',
+  additionalProperties: false,
+  minProperties: 1,
+  properties: {
+    themeColor: {
+      type: 'string',
+      pattern: hexColor.source,
+      default: baseTheme.themeColor,
+      description: `The generic theme color of the app.
+
+This is used for example in the URL bar on Android.
+`,
+    },
+    splashColor: {
+      type: 'string',
+      pattern: hexColor.source,
+      default: baseTheme.splashColor,
+      description: `The background color of the PWA splash screen.
+
+This defaults to the theme color.
+`,
+    },
+    primaryColor: {
+      type: 'string',
+      pattern: hexColor.source,
+      default: baseTheme.primaryColor,
+      description: `The primary color used within the app.
+
+This is used in various elements like the navbar.
+`,
+    },
+    linkColor: {
+      type: 'string',
+      pattern: hexColor.source,
+      default: baseTheme.linkColor,
+      description: 'The color used for links.',
+    },
+    infoColor: {
+      type: 'string',
+      pattern: hexColor.source,
+      default: baseTheme.infoColor,
+      description: 'The color used for informational messages.',
+    },
+    successColor: {
+      type: 'string',
+      pattern: hexColor.source,
+      default: baseTheme.successColor,
+      description: 'The color used for successful actions.',
+    },
+    warningColor: {
+      type: 'string',
+      pattern: hexColor.source,
+      default: baseTheme.warningColor,
+      description: 'The color used for warning messages.',
+    },
+    dangerColor: {
+      type: 'string',
+      pattern: hexColor.source,
+      default: baseTheme.dangerColor,
+      description: 'The color used for error messages.',
+    },
+    tileLayer: {
+      type: 'string',
+      format: 'uri',
+      default: baseTheme.tileLayer,
+      description: 'The tileLayer to use for Leaflet maps.',
+    },
+    font: {
+      description: 'The font to use in the app.',
+      anyOf: [
+        { $ref: '#/components/schemas/CustomFontDefinition' },
+        { $ref: '#/components/schemas/GoogleFontDefinition' },
+      ],
+    },
+  },
+};

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

@@ -0,0 +1 @@
+{"version":3,"file":"ThrowActionDefinition.js","sourceRoot":"","sources":["ThrowActionDefinition.ts"],"names":[],"mappings":";;;AAAA,iEAA8D;AAC9D,mCAA2C;AAE9B,QAAA,qBAAqB,GAAG,IAAA,wBAAgB,EAAC,2CAAoB,EAAE;IAC1E,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,OAAO,CAAC;YACf,WAAW,EAAE;;;CAGlB;SACI;KACF;CACF,CAAC,CAAC"}

package/api/components/schemas/ThrowActionDefinition.ts

@@ -0,0 +1,17 @@
+import { BaseActionDefinition } from './BaseActionDefinition';
+import { extendJSONSchema } from './utils';
+
+export const ThrowActionDefinition = extendJSONSchema(BaseActionDefinition, {
+  type: 'object',
+  additionalProperties: false,
+  required: ['type'],
+  properties: {
+    type: {
+      enum: ['throw'],
+      description: `This action throws a new exception based on the data that is passed through.
+
+This can be used to create a custom error that ends up in the error action handler.
+`,
+    },
+  },
+});

package/api/components/schemas/User.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.User = void 0;
+exports.User = {
+    type: 'object',
+    description: 'An object representing a user.',
+    additionalProperties: false,
+    properties: {
+        id: {
+            type: 'string',
+            readOnly: true,
+            description: 'The ID of the user.',
+        },
+        name: {
+            type: 'string',
+            description: 'The display name of the user.',
+        },
+        email: {
+            type: 'string',
+            description: 'The primary email used for communication.',
+        },
+        locale: {
+            type: 'string',
+            description: 'The locale of the user.',
+        },
+        timezone: {
+            enum: Intl.supportedValuesOf('timeZone'),
+            description: 'The time zone of the user.',
+        },
+    },
+};
+//# sourceMappingURL=User.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"User.js","sourceRoot":"","sources":["User.ts"],"names":[],"mappings":";;;AAEa,QAAA,IAAI,GAAmC;IAClD,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,gCAAgC;IAC7C,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACV,EAAE,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,qBAAqB;SACnC;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,+BAA+B;SAC7C;QACD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,2CAA2C;SACzD;QACD,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,yBAAyB;SACvC;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC;YACxC,WAAW,EAAE,4BAA4B;SAC1C;KACF;CACF,CAAC"}