@appsemble/utils 0.20.10 → 0.20.13

package/api/components/responses/blockVersion.ts

@@ -0,0 +1,12 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+export const blockVersion: OpenAPIV3.ResponseObject = {
+  description: 'A block definition response',
+  content: {
+    'application/json': {
+      schema: {
+        $ref: '#/components/schemas/BlockVersion',
+      },
+    },
+  },
+};

package/api/components/responses/default.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"default.js","sourceRoot":"","sources":["default.ts"],"names":[],"mappings":";;AAAA,kBAAe;IACb,WAAW,EAAE,6BAA6B;IAC1C,OAAO,EAAE;QACP,kBAAkB,EAAE;YAClB,MAAM,EAAE;gBACN,IAAI,EAAE,4BAA4B;aACnC;SACF;KACF;CACF,CAAC"}

package/api/components/responses/default.ts

@@ -0,0 +1,10 @@
+export default {
+  description: 'The default error response.',
+  content: {
+    'application/json': {
+      schema: {
+        $ref: '#/components/schemas/Error',
+      },
+    },
+  },
+};

package/api/components/responses/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,qCAAoC;AAA3B,mHAAA,OAAO,OAAA;AAChB,wCAAsB;AACtB,iDAA+B;AAC/B,2CAAyB;AACzB,4DAA0C;AAC1C,iDAA+B;AAC/B,6CAA2B;AAC3B,kDAAgC"}

package/api/components/responses/index.ts

@@ -0,0 +1,8 @@
+export { default } from './default';
+export * from './app';
+export * from './blockVersion';
+export * from './invite';
+export * from './oauth2AuthorizationCode';
+export * from './organization';
+export * from './resource';
+export * from './subscriptions';

package/api/components/responses/invite.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"invite.js","sourceRoot":"","sources":["invite.ts"],"names":[],"mappings":";;;AAEa,QAAA,MAAM,GAA6B;IAC9C,WAAW,EAAE,oBAAoB;IACjC,OAAO,EAAE;QACP,kBAAkB,EAAE;YAClB,MAAM,EAAE;gBACN,IAAI,EAAE,mCAAmC;aAC1C;SACF;KACF;CACF,CAAC"}

package/api/components/responses/invite.ts

@@ -0,0 +1,12 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+export const invite: OpenAPIV3.ResponseObject = {
+  description: 'An invite response',
+  content: {
+    'application/json': {
+      schema: {
+        $ref: '#/components/schemas/Organization',
+      },
+    },
+  },
+};

package/api/components/responses/oauth2AuthorizationCode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"oauth2AuthorizationCode.js","sourceRoot":"","sources":["oauth2AuthorizationCode.ts"],"names":[],"mappings":";;;AAEa,QAAA,uBAAuB,GAA6B;IAC/D,WAAW,EAAE,+BAA+B;IAC5C,OAAO,EAAE;QACP,kBAAkB,EAAE;YAClB,MAAM,EAAE;gBACN,IAAI,EAAE,0BAA0B;aACjC;SACF;KACF;CACF,CAAC"}

package/api/components/responses/oauth2AuthorizationCode.ts

@@ -0,0 +1,12 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+export const oauth2AuthorizationCode: OpenAPIV3.ResponseObject = {
+  description: 'An OAuth2 authorization code.',
+  content: {
+    'application/json': {
+      schema: {
+        $ref: '#/components/schemas/App',
+      },
+    },
+  },
+};

package/api/components/responses/organization.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"organization.js","sourceRoot":"","sources":["organization.ts"],"names":[],"mappings":";;;AAEa,QAAA,YAAY,GAA6B;IACpD,WAAW,EAAE,0BAA0B;IACvC,OAAO,EAAE;QACP,kBAAkB,EAAE;YAClB,MAAM,EAAE;gBACN,IAAI,EAAE,mCAAmC;aAC1C;SACF;KACF;CACF,CAAC"}

package/api/components/responses/organization.ts

@@ -0,0 +1,12 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+export const organization: OpenAPIV3.ResponseObject = {
+  description: 'An organization response',
+  content: {
+    'application/json': {
+      schema: {
+        $ref: '#/components/schemas/Organization',
+      },
+    },
+  },
+};

package/api/components/responses/resource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource.js","sourceRoot":"","sources":["resource.ts"],"names":[],"mappings":";;;AAEa,QAAA,QAAQ,GAA6B;IAChD,WAAW,EAAE,qBAAqB;IAClC,OAAO,EAAE;QACP,kBAAkB,EAAE;YAClB,MAAM,EAAE;gBACN,IAAI,EAAE,+BAA+B;aACtC;SACF;QACD,UAAU,EAAE;YACV,MAAM,EAAE;gBACN,IAAI,EAAE,QAAQ;aACf;SACF;KACF;CACF,CAAC"}

package/api/components/responses/resource.ts

@@ -0,0 +1,17 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+export const resource: OpenAPIV3.ResponseObject = {
+  description: 'A resource response',
+  content: {
+    'application/json': {
+      schema: {
+        $ref: '#/components/schemas/Resource',
+      },
+    },
+    'text/csv': {
+      schema: {
+        type: 'string',
+      },
+    },
+  },
+};

package/api/components/responses/subscriptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscriptions.js","sourceRoot":"","sources":["subscriptions.ts"],"names":[],"mappings":";;;AAEa,QAAA,aAAa,GAA6B;IACrD,WAAW,EAAE,0BAA0B;IACvC,OAAO,EAAE;QACP,kBAAkB,EAAE;YAClB,MAAM,EAAE;gBACN,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,yDAAyD;gBACtE,oBAAoB,EAAE;oBACpB,IAAI,EAAE,2CAA2C;iBAClD;aACF;SACF;KACF;CACF,CAAC"}

package/api/components/responses/subscriptions.ts

@@ -0,0 +1,16 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+export const subscriptions: OpenAPIV3.ResponseObject = {
+  description: 'A subscription response.',
+  content: {
+    'application/json': {
+      schema: {
+        type: 'object',
+        description: 'A mapping of resources names to resource subscriptions.',
+        additionalProperties: {
+          $ref: '#/components/schemas/ResourceSubscription',
+        },
+      },
+    },
+  },
+};

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

@@ -0,0 +1 @@
+{"version":3,"file":"ActionDefinition.js","sourceRoot":"","sources":["ActionDefinition.ts"],"names":[],"mappings":";;;AAEa,QAAA,gBAAgB,GAAmC;IAC9D,KAAK,EAAE;QACL;YACE,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,8CAA8C;YAC3D,oBAAoB,EAAE,IAAI;YAC1B,UAAU,EAAE;gBACV,WAAW,EAAE;oBACX,IAAI,EAAE,yCAAyC;oBAC/C,WAAW,EACT,8EAA8E;iBACjF;gBACD,UAAU,EAAE;oBACV,IAAI,EAAE,yCAAyC;oBAC/C,WAAW,EACT,6EAA6E;iBAChF;gBACD,SAAS,EAAE;oBACT,IAAI,EAAE,uCAAuC;oBAC7C,WAAW,EACT,qFAAqF;iBACxF;gBACD,OAAO,EAAE;oBACP,IAAI,EAAE,uCAAuC;oBAC7C,WAAW,EACT,wFAAwF;iBAC3F;aACF;SACF;QACD;YACE,KAAK,EAAE;gBACL,EAAE,IAAI,EAAE,gDAAgD,EAAE;gBAC1D,EAAE,IAAI,EAAE,gDAAgD,EAAE;gBAC1D,EAAE,IAAI,EAAE,6CAA6C,EAAE;gBACvD,EAAE,IAAI,EAAE,kDAAkD,EAAE;gBAC5D,EAAE,IAAI,EAAE,+CAA+C,EAAE;gBACzD,EAAE,IAAI,EAAE,+CAA+C,EAAE;gBACzD,EAAE,IAAI,EAAE,4CAA4C,EAAE;gBACtD,EAAE,IAAI,EAAE,4CAA4C,EAAE;gBACtD,EAAE,IAAI,EAAE,+CAA+C,EAAE;gBACzD,EAAE,IAAI,EAAE,iDAAiD,EAAE;gBAC3D,EAAE,IAAI,EAAE,+CAA+C,EAAE;gBACzD,EAAE,IAAI,EAAE,6CAA6C,EAAE;gBACvD,EAAE,IAAI,EAAE,2CAA2C,EAAE;gBACrD,EAAE,IAAI,EAAE,+CAA+C,EAAE;gBACzD,EAAE,IAAI,EAAE,+CAA+C,EAAE;gBACzD,EAAE,IAAI,EAAE,0CAA0C,EAAE;gBACpD,EAAE,IAAI,EAAE,8CAA8C,EAAE;gBACxD,EAAE,IAAI,EAAE,2CAA2C,EAAE;gBACrD,EAAE,IAAI,EAAE,8CAA8C,EAAE;gBACxD,EAAE,IAAI,EAAE,oDAAoD,EAAE;gBAC9D,EAAE,IAAI,EAAE,qDAAqD,EAAE;gBAC/D,EAAE,IAAI,EAAE,qDAAqD,EAAE;gBAC/D,EAAE,IAAI,EAAE,kDAAkD,EAAE;gBAC5D,EAAE,IAAI,EAAE,oDAAoD,EAAE;gBAC9D,EAAE,IAAI,EAAE,iEAAiE,EAAE;gBAC3E,EAAE,IAAI,EAAE,oEAAoE,EAAE;gBAC9E,EAAE,IAAI,EAAE,iEAAiE,EAAE;gBAC3E,EAAE,IAAI,EAAE,sEAAsE,EAAE;gBAChF,EAAE,IAAI,EAAE,qDAAqD,EAAE;gBAC/D,EAAE,IAAI,EAAE,4CAA4C,EAAE;gBACtD,EAAE,IAAI,EAAE,4CAA4C,EAAE;gBACtD,EAAE,IAAI,EAAE,6CAA6C,EAAE;gBACvD,EAAE,IAAI,EAAE,kDAAkD,EAAE;gBAC5D,EAAE,IAAI,EAAE,kDAAkD,EAAE;gBAC5D,EAAE,IAAI,EAAE,mDAAmD,EAAE;gBAC7D,EAAE,IAAI,EAAE,mDAAmD,EAAE;gBAC7D,EAAE,IAAI,EAAE,iDAAiD,EAAE;gBAC3D,EAAE,IAAI,EAAE,+CAA+C,EAAE;gBACzD,EAAE,IAAI,EAAE,+CAA+C,EAAE;gBACzD,EAAE,IAAI,EAAE,4CAA4C,EAAE;gBACtD,EAAE,IAAI,EAAE,gDAAgD,EAAE;gBAC1D,EAAE,IAAI,EAAE,mDAAmD,EAAE;gBAC7D,EAAE,IAAI,EAAE,iDAAiD,EAAE;aAC5D;SACF;KACF;CACF,CAAC"}

package/api/components/schemas/ActionDefinition.ts

@@ -0,0 +1,80 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+export const ActionDefinition: OpenAPIV3.NonArraySchemaObject = {
+  allOf: [
+    {
+      type: 'object',
+      description: 'The base properties of an action definition.',
+      additionalProperties: true,
+      properties: {
+        remapBefore: {
+          $ref: '#/components/schemas/RemapperDefinition',
+          description:
+            'This may be used to remap data before it is passed into the action function.',
+        },
+        remapAfter: {
+          $ref: '#/components/schemas/RemapperDefinition',
+          description:
+            'This may be used to remap data after it is passed into the action function.',
+        },
+        onSuccess: {
+          $ref: '#/components/schemas/ActionDefinition',
+          description:
+            'Another action that is dispatched when the action has been dispatched successfully.',
+        },
+        onError: {
+          $ref: '#/components/schemas/ActionDefinition',
+          description:
+            'Another action that is dispatched when the action has failed to dispatch successfully.',
+        },
+      },
+    },
+    {
+      anyOf: [
+        { $ref: '#/components/schemas/AnalyticsActionDefinition' },
+        { $ref: '#/components/schemas/ConditionActionDefinition' },
+        { $ref: '#/components/schemas/DialogActionDefinition' },
+        { $ref: '#/components/schemas/DialogErrorActionDefinition' },
+        { $ref: '#/components/schemas/DialogOkActionDefinition' },
+        { $ref: '#/components/schemas/DownloadActionDefinition' },
+        { $ref: '#/components/schemas/EmailActionDefinition' },
+        { $ref: '#/components/schemas/EventActionDefinition' },
+        { $ref: '#/components/schemas/FlowBackActionDefinition' },
+        { $ref: '#/components/schemas/FlowFinishActionDefinition' },
+        { $ref: '#/components/schemas/FlowNextActionDefinition' },
+        { $ref: '#/components/schemas/FlowToActionDefinition' },
+        { $ref: '#/components/schemas/LinkActionDefinition' },
+        { $ref: '#/components/schemas/LinkBackActionDefinition' },
+        { $ref: '#/components/schemas/LinkNextActionDefinition' },
+        { $ref: '#/components/schemas/LogActionDefinition' },
+        { $ref: '#/components/schemas/MessageActionDefinition' },
+        { $ref: '#/components/schemas/NoopActionDefinition' },
+        { $ref: '#/components/schemas/RequestActionDefinition' },
+        { $ref: '#/components/schemas/ResourceCountActionDefinition' },
+        { $ref: '#/components/schemas/ResourceCreateActionDefinition' },
+        { $ref: '#/components/schemas/ResourceDeleteActionDefinition' },
+        { $ref: '#/components/schemas/ResourceGetActionDefinition' },
+        { $ref: '#/components/schemas/ResourceQueryActionDefinition' },
+        { $ref: '#/components/schemas/ResourceSubscriptionStatusActionDefinition' },
+        { $ref: '#/components/schemas/ResourceSubscriptionSubscribeActionDefinition' },
+        { $ref: '#/components/schemas/ResourceSubscriptionToggleActionDefinition' },
+        { $ref: '#/components/schemas/ResourceSubscriptionUnsubscribeActionDefinition' },
+        { $ref: '#/components/schemas/ResourceUpdateActionDefinition' },
+        { $ref: '#/components/schemas/ShareActionDefinition' },
+        { $ref: '#/components/schemas/ShareActionDefinition' },
+        { $ref: '#/components/schemas/StaticActionDefinition' },
+        { $ref: '#/components/schemas/StorageReadActionDefinition' },
+        { $ref: '#/components/schemas/StorageReadActionDefinition' },
+        { $ref: '#/components/schemas/StorageWriteActionDefinition' },
+        { $ref: '#/components/schemas/StorageWriteActionDefinition' },
+        { $ref: '#/components/schemas/TeamInviteActionDefinition' },
+        { $ref: '#/components/schemas/TeamJoinActionDefinition' },
+        { $ref: '#/components/schemas/TeamListActionDefinition' },
+        { $ref: '#/components/schemas/ThrowActionDefinition' },
+        { $ref: '#/components/schemas/UserLoginActionDefinition' },
+        { $ref: '#/components/schemas/UserRegisterActionDefinition' },
+        { $ref: '#/components/schemas/UserUpdateActionDefinition' },
+      ],
+    },
+  ],
+};

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

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsActionDefinition.js","sourceRoot":"","sources":["AnalyticsActionDefinition.ts"],"names":[],"mappings":";;;AAAA,iEAA8D;AAC9D,mCAA2C;AAE9B,QAAA,yBAAyB,GAAG,IAAA,wBAAgB,EAAC,2CAAoB,EAAE;IAC9E,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC;IAC5B,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,WAAW,CAAC;YACnB,WAAW,EAAE;;;CAGlB;SACI;QACD,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,iDAAiD;SAC/D;QACD,MAAM,EAAE;YACN,IAAI,EAAE,yCAAyC;YAC/C,WAAW,EAAE,gFAAgF;SAC9F;KACF;CACF,CAAC,CAAC"}

package/api/components/schemas/AnalyticsActionDefinition.ts

@@ -0,0 +1,25 @@
+import { BaseActionDefinition } from './BaseActionDefinition';
+import { extendJSONSchema } from './utils';
+
+export const AnalyticsActionDefinition = extendJSONSchema(BaseActionDefinition, {
+  type: 'object',
+  additionalProperties: false,
+  required: ['type', 'target'],
+  properties: {
+    type: {
+      enum: ['analytics'],
+      description: `This action sends a Google Analytics event.
+
+It returns the input data.
+`,
+    },
+    target: {
+      type: 'string',
+      description: 'The name of the analytics target event to send.',
+    },
+    config: {
+      $ref: '#/components/schemas/RemapperDefinition',
+      description: 'A remapper whose result will be sent to Google Analytics as additional context',
+    },
+  },
+});

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

@@ -0,0 +1 @@
+{"version":3,"file":"App.js","sourceRoot":"","sources":["App.ts"],"names":[],"mappings":";;;AAEA,kDAA0E;AAE7D,QAAA,GAAG,GAAmC;IACjD,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,uDAAuD;IACpE,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACV,EAAE,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,CAAC;YACV,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE;;;CAGlB;SACI;QACD,cAAc,EAAE;YACd,IAAI,EAAE,iDAAiD;SACxD;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,EAAE;YACb,OAAO,EAAE,sBAAU,CAAC,MAAM;YAC1B,WAAW,EAAE;;;;CAIlB;SACI;QACD,MAAM,EAAE;YACN,KAAK,EAAE;gBACL,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE;gBAChC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE;aACvC;YACD,WAAW,EAAE;;;;CAIlB;SACI;QACD,UAAU,EAAE;YACV,WAAW,EAAE;;;;;;;;CAQlB;YACK,OAAO,EAAE,UAAU;YACnB,IAAI,EAAE,CAAC,QAAQ,EAAE,UAAU,EAAE,SAAS,CAAC;SACxC;QACD,iBAAiB,EAAE;YACjB,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,8EAA8E;SAC5F;QACD,MAAM,EAAE;YACN,IAAI,EAAE,SAAS;YACf,WAAW,EAAE;;;CAGlB;SACI;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,6EAA6E;SAC3F;QACD,eAAe,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE;;;;CAIlB;SACI;QACD,UAAU,EAAE,EAAE,IAAI,EAAE,oCAAoC,EAAE;QAC1D,cAAc,EAAE;YACd,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,4CAA4C;YACzD,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;SAC1B;QACD,iBAAiB,EAAE;YACjB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,mEAAmE;YAChF,OAAO,EAAE,oCAAwB,CAAC,MAAM;SACzC;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE;;;;CAIlB;YACK,MAAM,EAAE,KAAK;SACd;QACD,iBAAiB,EAAE;YACjB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE;;wDAEqC;SACnD;KACF;CACF,CAAC"}

package/api/components/schemas/App.ts

@@ -0,0 +1,107 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+import { googleAnalyticsIDPattern, normalized } from '../../../constants';
+
+export const App: OpenAPIV3.NonArraySchemaObject = {
+  type: 'object',
+  description: 'An app definition defines what an app will look like.',
+  additionalProperties: false,
+  properties: {
+    id: {
+      type: 'number',
+      minimum: 0,
+      readOnly: true,
+      description: `The unique identifier for the app.
+
+This value will be generated automatically by the API.
+`,
+    },
+    OrganizationId: {
+      $ref: '#/components/schemas/Organization/properties/id',
+    },
+    path: {
+      type: 'string',
+      minLength: 1,
+      maxLength: 30,
+      pattern: normalized.source,
+      description: `The URL path segment on which this app is reachable.
+
+This may only contain lower case characters, numbers, and hyphens. By default this is a
+normalized version of the app name.
+`,
+    },
+    domain: {
+      anyOf: [
+        { type: 'string', maxLength: 0 },
+        { type: 'string', format: 'hostname' },
+      ],
+      description: `The domain name on which this app should be served.
+
+If this is unspecified, the app will be served from the path on the domain of the server
+\`HOSTNAME\` variable.
+`,
+    },
+    visibility: {
+      description: `Determine the app visibility of the app in the Appsemble app store.
+
+This doesn’t affect whether or not the app can be accessed on its own domain.
+
+- **public**: The app is publicly listed in the Appsemble app store.
+- **unlisted**: The app store page can be accessed, but the app isn’t listed publicly in the
+  Appsemble app store.
+- **private**: The app is only visible to people who are part of the organization.
+`,
+      default: 'unlisted',
+      enum: ['public', 'unlisted', 'private'],
+    },
+    showAppDefinition: {
+      type: 'boolean',
+      description: 'Whether or not people who have access to the app may see the app definition.',
+    },
+    locked: {
+      type: 'boolean',
+      description: `Determines whether this app should be locked from being updated.
+
+This must be set to \`false\` before any other changes can be made to an app.
+`,
+    },
+    template: {
+      type: 'boolean',
+      description: 'Determines whether this app should be included when fetching for templates.',
+    },
+    longDescription: {
+      type: 'string',
+      description: `
+A long description for the app.
+
+The long desciption will be rendered on the app details page. Markdown content is supported.
+`,
+    },
+    definition: { $ref: '#/components/schemas/AppDefinition' },
+    screenshotUrls: {
+      type: 'array',
+      description: 'A list of URLs referencing app screenshots',
+      items: { type: 'string' },
+    },
+    googleAnalyticsID: {
+      type: 'string',
+      description: 'If this is specified, Google analytics will be applied to the app',
+      pattern: googleAnalyticsIDPattern.source,
+    },
+    sentryDsn: {
+      type: 'string',
+      description: `The Sentry DSN to use for this app.
+
+If this is specified, the given Sentry DSN will be used for error tracking. Apps without a custom
+domain fall back to use the Appsemble server Sentry DSN.
+`,
+      format: 'url',
+    },
+    sentryEnvironment: {
+      type: 'string',
+      description: `The name that should be used as the sentry environment.
+
+  This is only applied when \`sentryDsn\` is specified.`,
+    },
+  },
+};

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

@@ -0,0 +1 @@
+{"version":3,"file":"AppAccount.js","sourceRoot":"","sources":["AppAccount.ts"],"names":[],"mappings":";;;AAEa,QAAA,UAAU,GAAmC;IACxD,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,qCAAqC;IAClD,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,yCAAyC;SACvD;QACD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,OAAO;YACf,WAAW,EAAE,kDAAkD;SAChE;QACD,cAAc,EAAE;YACd,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,+CAA+C;SAC7D;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,qCAAqC;SACnD;QACD,GAAG,EAAE;YACH,IAAI,EAAE,oCAAoC;SAC3C;QACD,GAAG,EAAE;YACH,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,+EAA+E;YAC5F,KAAK,EAAE,EAAE,IAAI,EAAE,uCAAuC,EAAE;SACzD;QACD,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,sCAAsC;SACpD;KACF;CACF,CAAC"}

package/api/components/schemas/AppAccount.ts

@@ -0,0 +1,39 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+export const AppAccount: OpenAPIV3.NonArraySchemaObject = {
+  type: 'object',
+  description: 'An user account connected to an app',
+  additionalProperties: false,
+  properties: {
+    name: {
+      type: 'string',
+      description: 'The name as it is available in the app.',
+    },
+    email: {
+      type: 'string',
+      format: 'email',
+      description: 'The email address as it is available in the app.',
+    },
+    email_verified: {
+      type: 'boolean',
+      description: 'Whether this email address has been verified.',
+    },
+    role: {
+      type: 'string',
+      description: 'The role of the user within the app',
+    },
+    app: {
+      $ref: '#/components/schemas/AppDefinition',
+    },
+    sso: {
+      type: 'array',
+      description: 'The single sign on configurations which link the user to an external account.',
+      items: { $ref: '#/components/schemas/SSOConfiguration' },
+    },
+    avatar: {
+      type: 'string',
+      format: 'url',
+      description: 'The URL of the avatar of the member.',
+    },
+  },
+};

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

@@ -0,0 +1 @@
+{"version":3,"file":"AppDefinition.js","sourceRoot":"","sources":["AppDefinition.ts"],"names":[],"mappings":";;;AAEA,kDAAmD;AAEtC,QAAA,aAAa,GAAmC;IAC3D,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC;IAC1C,oBAAoB,EAAE,KAAK;IAC3B,WAAW,EAAE,+DAA+D;IAC5E,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,EAAE;YACb,WAAW,EAAE;;;CAGlB;SACI;QACD,KAAK,EAAE;YACL,IAAI,EAAE,OAAO;YACb,WAAW,EAAE;;;;;CAKlB;YACK,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;aACf;SACF;QACD,WAAW,EAAE;YACX,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,EAAE;YACb,WAAW,EAAE;;;CAGlB;SACI;QACD,MAAM,EAAE;YACN,IAAI,EAAE,0CAA0C;YAChD,WAAW,EAAE,8CAA8C;SAC5D;QACD,aAAa,EAAE;YACb,IAAI,EAAE,CAAC,QAAQ,EAAE,SAAS,CAAC;YAC3B,WAAW,EAAE;;;;;;;;CAQlB;SACI;QACD,WAAW,EAAE;YACX,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE;;;CAGlB;SACI;QACD,eAAe,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,yBAAa;YACtB,SAAS,EAAE,CAAC;YACZ,WAAW,EAAE,mCAAmC;SACjD;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE;;;CAGlB;YACK,oBAAoB,EAAE;gBACpB,WAAW,EAAE,+BAA+B;gBAC5C,IAAI,EAAE,yCAAyC;aAChD;SACF;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,yCAAyC;YAC/C,WAAW,EAAE,+CAA+C;SAC7D;QACD,KAAK,EAAE;YACL,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,CAAC;YACX,WAAW,EAAE,uBAAuB;YACpC,KAAK,EAAE;gBACL,KAAK,EAAE;oBACL,EAAE,IAAI,EAAE,qCAAqC,EAAE;oBAC/C,EAAE,IAAI,EAAE,yCAAyC,EAAE;oBACnD,EAAE,IAAI,EAAE,yCAAyC,EAAE;iBACpD;aACF;SACF;QACD,KAAK,EAAE;YACL,IAAI,EAAE,4BAA4B;SACnC;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,aAAa,EAAE,CAAC;YAChB,WAAW,EAAE,wDAAwD;YACrE,oBAAoB,EAAE,EAAE,IAAI,EAAE,qCAAqC,EAAE;SACtE;QACD,OAAO,EAAE;YACP,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,CAAC;YACX,WAAW,EAAE,yDAAyD;YACtE,KAAK,EAAE,EAAE;SACV;KACF;CACF,CAAC"}

package/api/components/schemas/AppDefinition.ts

@@ -0,0 +1,112 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+import { defaultLocale } from '../../../constants';
+
+export const AppDefinition: OpenAPIV3.NonArraySchemaObject = {
+  type: 'object',
+  required: ['name', 'defaultPage', 'pages'],
+  additionalProperties: false,
+  description: 'An app definition describes what an Appsemble app looks like.',
+  properties: {
+    name: {
+      type: 'string',
+      minLength: 1,
+      maxLength: 30,
+      description: `The human readable name of the app.
+
+This will be displayed for example on the home screen or in the browser tab.
+`,
+    },
+    roles: {
+      type: 'array',
+      description: `The list of roles that are allowed to view this app.
+
+This list is used as the default roles for the roles property on pages and blocks, which can be
+overridden by defining them for a specific page or block. Note that these roles must be defined in
+\`security.roles\`.
+`,
+      items: {
+        type: 'string',
+      },
+    },
+    description: {
+      type: 'string',
+      maxLength: 80,
+      description: `A short description describing the app.
+
+This will be displayed on the app store.
+`,
+    },
+    layout: {
+      $ref: '#/components/schemas/AppLayoutDefinition',
+      description: 'Properties related to the layout of the app.',
+    },
+    notifications: {
+      enum: ['opt-in', 'startup'],
+      description: `The strategy to use for apps to subscribe to push notifications.
+
+If specified, push notifications can be sent to subscribed users via the _Notifications_ tab in the
+app details page in Appsemble Studio. Setting this to \`opt-in\` allows for users to opt into
+receiving push notifications by pressing the subscribe button in the App settings page. Setting this
+to \`startup\` will cause Appsemble to immediately request for the permission upon opening the app.
+
+> **Note**: Setting \`notifications\` to \`startup\` is not recommended, due to its invasive nature.
+`,
+    },
+    defaultPage: {
+      type: 'string',
+      description: `The name of the page that should be displayed when the app is initially loaded.
+
+This **must** match the name of a page defined for the app.
+`,
+    },
+    defaultLanguage: {
+      type: 'string',
+      default: defaultLocale,
+      minLength: 2,
+      description: 'The default language for the app.',
+    },
+    resources: {
+      type: 'object',
+      description: `Resources define how Appsemble can store data for an app.
+
+The most basic resource has a \`schema\` property and defines the minimal security rules.
+`,
+      additionalProperties: {
+        description: 'A single resource definition.',
+        $ref: '#/components/schemas/ResourceDefinition',
+      },
+    },
+    security: {
+      $ref: '#/components/schemas/SecurityDefinition',
+      description: 'Role definitions that may be used by the app.',
+    },
+    pages: {
+      type: 'array',
+      minItems: 1,
+      description: 'The pages of the app.',
+      items: {
+        anyOf: [
+          { $ref: '#/components/schemas/PageDefinition' },
+          { $ref: '#/components/schemas/TabsPageDefinition' },
+          { $ref: '#/components/schemas/FlowPageDefinition' },
+        ],
+      },
+    },
+    theme: {
+      $ref: '#/components/schemas/Theme',
+    },
+    cron: {
+      type: 'object',
+      minProperties: 1,
+      description: 'A list of cron jobs that are associated with this app.',
+      additionalProperties: { $ref: '#/components/schemas/CronDefinition' },
+    },
+    anchors: {
+      type: 'array',
+      minItems: 1,
+      description: 'Helper property that can be used to store YAML anchors.',
+      items: {},
+    },
+  },
+};

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

@@ -0,0 +1 @@
+{"version":3,"file":"AppLayoutDefinition.js","sourceRoot":"","sources":["AppLayoutDefinition.ts"],"names":[],"mappings":";;;AAEa,QAAA,mBAAmB,GAAmC;IACjE,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,+EAA+E;IAC5F,oBAAoB,EAAE,KAAK;IAC3B,aAAa,EAAE,CAAC;IAChB,UAAU,EAAE;QACV,KAAK,EAAE;YACL,IAAI,EAAE,CAAC,QAAQ,EAAE,YAAY,EAAE,QAAQ,CAAC;YACxC,OAAO,EAAE,QAAQ;YACjB,WAAW,EAAE,mCAAmC;SACjD;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,CAAC,QAAQ,EAAE,YAAY,EAAE,QAAQ,CAAC;YACxC,OAAO,EAAE,QAAQ;YACjB,WAAW,EAAE;;;CAGlB;SACI;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,CAAC,QAAQ,EAAE,YAAY,EAAE,QAAQ,CAAC;YACxC,OAAO,EAAE,YAAY;YACrB,WAAW,EAAE;;;CAGlB;SACI;QACD,UAAU,EAAE;YACV,IAAI,EAAE,CAAC,QAAQ,EAAE,WAAW,EAAE,QAAQ,CAAC;YACvC,OAAO,EAAE,WAAW;YACpB,WAAW,EAAE;;;CAGlB;SACI;KACF;CACF,CAAC"}

package/api/components/schemas/AppLayoutDefinition.ts

@@ -0,0 +1,39 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+export const AppLayoutDefinition: OpenAPIV3.NonArraySchemaObject = {
+  type: 'object',
+  description: 'The layout definition allows you to tweak several layout elements of the app.',
+  additionalProperties: false,
+  minProperties: 1,
+  properties: {
+    login: {
+      enum: ['navbar', 'navigation', 'hidden'],
+      default: 'navbar',
+      description: 'The location of the login button.',
+    },
+    settings: {
+      enum: ['navbar', 'navigation', 'hidden'],
+      default: 'navbar',
+      description: `The location of the settings button.
+
+If set to \`navigation\`, it will only be visible if \`login\` is also visible in \`navigation\`.
+`,
+    },
+    feedback: {
+      enum: ['navbar', 'navigation', 'hidden'],
+      default: 'navigation',
+      description: `The location of the feedback button.
+
+If set to \`navigation\`, it will only be visible if \`login\` is also visible in \`navigation\`.
+`,
+    },
+    navigation: {
+      enum: ['bottom', 'left-menu', 'hidden'],
+      default: 'left-menu',
+      description: `The navigation type to use.
+
+If this is omitted, a collapsable side navigation menu will be rendered on the left.
+`,
+    },
+  },
+};