@appsemble/utils 0.36.8 → 0.36.10-test.0

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.36.8/config/assets/logo.svg) Appsemble Utilities
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.36.10-test.0/config/assets/logo.svg) Appsemble Utilities
 
 > Internal utility functions used across multiple Appsemble projects.
 
 [![npm](https://img.shields.io/npm/v/@appsemble/utils)](https://www.npmjs.com/package/@appsemble/utils)
-[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.36.8/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.36.8)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.36.10-test.0/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.36.10-test.0)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
 ## Table of Contents
@@ -26,5 +26,5 @@ not guaranteed.
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.36.8/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.36.10-test.0/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/api/components/securitySchemes/app.js

@@ -1,11 +1,4 @@
-const scopes = {
-    email: 'Read the user email address.',
-    openid: 'Login the user to the requesting app using OpenID.',
-    profile: 'Read the user profile, including the display name and profile picture.',
-    'resources:manage': 'Manage app resources on behalf of a user.',
-    'groups:read': 'Read the groups the user is a part of.',
-    'groups:write': 'Add new members to a group.',
-};
+import { appOAuth2Scopes as scopes } from '../../../constants/index.js';
 export const app = {
     type: 'oauth2',
     description: `

package/api/paths/apps/appId/assets/assetId/download.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/apps/appId/assets/assetId/download.js

@@ -0,0 +1,18 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/assetId' },
+    ],
+    get: {
+        tags: ['main', 'app', 'asset'],
+        description: 'Download the original asset binary.',
+        operationId: 'getOriginalAppAsset',
+        responses: {
+            200: {
+                description: 'The original asset that matches the given id.',
+            },
+        },
+        security: [{ studio: [] }, { cli: ['assets:write'] }],
+    },
+};
+//# sourceMappingURL=download.js.map

package/api/paths/apps/appId/assets/assetId.js

@@ -7,7 +7,7 @@ export const pathItems = {
     ],
     get: {
         tags: ['common', 'app', 'asset'],
-        description: 'Get a single asset',
+        description: 'Get a single asset. Public image delivery uses AVIF derivatives by default.',
         operationId: 'getAppAssetById',
         responses: {
             200: {
@@ -17,7 +17,7 @@ export const pathItems = {
     },
     head: {
         tags: ['common', 'app', 'asset'],
-        description: 'Get the headers for a single asset',
+        description: 'Get the headers for a single asset. Public image delivery headers describe AVIF derivatives by default.',
         operationId: 'getAppAssetHeadersById',
         responses: {
             200: {

package/api/paths/index.d.ts

@@ -16,6 +16,7 @@ export declare const paths: {
     '/api/apps/{appId}/clonable-assets': import("openapi-types").OpenAPIV3.PathItemObject<{}>;
     '/api/apps/{appId}/clonable-resources': import("openapi-types").OpenAPIV3.PathItemObject<{}>;
     '/api/apps/{appId}/assets/\\$count': import("openapi-types").OpenAPIV3.PathItemObject<{}>;
+    '/api/apps/{appId}/assets/{assetId}/download': import("openapi-types").OpenAPIV3.PathItemObject<{}>;
     '/api/apps/{appId}/assets/{assetId}': import("openapi-types").OpenAPIV3.PathItemObject<{}>;
     '/api/apps/{appId}/assets': import("openapi-types").OpenAPIV3.PathItemObject<{}>;
     '/api/apps/{appId}/broadcast': import("openapi-types").OpenAPIV3.PathItemObject<{}>;

package/api/paths/index.js

@@ -6,6 +6,7 @@ import { pathItems as appCollectionsAppCollectionIdHeaderImage } from './app-col
 import { pathItems as appCollectionsAppCollectionId } from './app-collections/appCollectionId.js';
 import { pathItems as appCollections } from './appCollections.js';
 import { pathItems as appsAppIdActionsPath } from './apps/appId/actions/path.js';
+import { pathItems as appsAppIdAssetsAssetIdDownload } from './apps/appId/assets/assetId/download.js';
 import { pathItems as appsAppIdAssetsAssetId } from './apps/appId/assets/assetId.js';
 import { pathItems as appsAppIdAssets$Count } from './apps/appId/assets/count.js';
 import { pathItems as appsAppIdAssets } from './apps/appId/assets.js';
@@ -186,6 +187,7 @@ export const paths = {
     // XXX: Temporary workaround until this is fixed in Koas
     // See https://gitlab.com/remcohaszing/koas/-/issues/2
     '/api/apps/{appId}/assets/\\$count': appsAppIdAssets$Count,
+    '/api/apps/{appId}/assets/{assetId}/download': appsAppIdAssetsAssetIdDownload,
     '/api/apps/{appId}/assets/{assetId}': appsAppIdAssetsAssetId,
     '/api/apps/{appId}/assets': appsAppIdAssets,
     '/api/apps/{appId}/broadcast': appsAppIdBroadcast,

package/api/paths/organizations/organizationId.js

@@ -9,6 +9,7 @@ export const pathItems = {
                 $ref: '#/components/responses/organization',
             },
         },
+        security: [{ studio: [] }, { cli: ['organizations:write'] }, {}],
     },
     patch: {
         tags: ['main', 'organization'],

package/constants/scopes.d.ts

@@ -2,3 +2,12 @@
  * All known OAuth2 scopes for client credentials.
  */
 export declare const scopes: readonly ["apps:export", "apps:write", "apps:delete", "blocks:write", "blocks:delete", "organizations:write", "resources:read", "resources:write", "assets:write", "groups:read", "groups:write"];
+export declare const appOAuth2Scopes: {
+    readonly email: "Read the user email address.";
+    readonly openid: "Login the user to the requesting app using OpenID.";
+    readonly profile: "Read the user profile, including the display name and profile picture.";
+    readonly 'resources:manage': "Manage app resources on behalf of a user.";
+    readonly 'groups:read': "Read the groups the user is a part of.";
+    readonly 'groups:write': "Add new members to a group.";
+};
+export declare const appOAuth2Scope: string;

package/constants/scopes.js

@@ -14,4 +14,13 @@ export const scopes = [
     'groups:read',
     'groups:write',
 ];
+export const appOAuth2Scopes = {
+    email: 'Read the user email address.',
+    openid: 'Login the user to the requesting app using OpenID.',
+    profile: 'Read the user profile, including the display name and profile picture.',
+    'resources:manage': 'Manage app resources on behalf of a user.',
+    'groups:read': 'Read the groups the user is a part of.',
+    'groups:write': 'Add new members to a group.',
+};
+export const appOAuth2Scope = Object.keys(appOAuth2Scopes).join(' ');
 //# sourceMappingURL=scopes.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/utils",
-  "version": "0.36.8",
+  "version": "0.36.10-test.0",
   "description": "Utility functions used in Appsemble internally",
   "keywords": [
     "app",
@@ -39,8 +39,8 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/lang-sdk": "0.36.8",
-    "@appsemble/types": "0.36.8",
+    "@appsemble/lang-sdk": "0.36.10-test.0",
+    "@appsemble/types": "0.36.10-test.0",
     "@fortawesome/fontawesome-common-types": "^6.0.0",
     "axios": "^1.0.0",
     "langmap": "^0.0.16",