@appsemble/types - npm Package Compare versions

Comparing version 0.15.4 to 0.15.5

dist/index.d.ts

@@ -1,7 +0,7 @@
-import type { Action, BaseMessage, HTTPMethods, LogAction, RequestLikeActionTypes, Theme } from '@appsemble/sdk/src/types';
-import type { IconName } from '@fortawesome/fontawesome-common-types';
-import type { OpenAPIV3 } from 'openapi-types';
-import type { JsonObject, RequireExactlyOne } from 'type-fest';
-import type { Definition } from 'typescript-json-schema';
-export type { Theme };
+import { Action, BaseMessage, HTTPMethods, LogAction, RequestLikeActionTypes, Theme } from '@appsemble/sdk/src/types';
+import { IconName } from '@fortawesome/fontawesome-common-types';
+import { OpenAPIV3 } from 'openapi-types';
+import { JsonObject, RequireExactlyOne } from 'type-fest';
+import { Definition } from 'typescript-json-schema';
+export { Theme };
 /**
@@ -68,5 +68,3 @@ * A representation of a generated OAuth2 authorization code response.
      */
-    actions?: {
-        [action: string]: ActionDefinition;
-    };
+    actions?: Record<string, ActionDefinition>;
     /**
@@ -78,8 +76,4 @@ * Mapping of the events the block can listen to and emit.
     events?: {
-        listen?: {
-            [listener: string]: string;
-        };
-        emit?: {
-            [emitter: string]: string;
-        };
+        listen?: Record<string, string>;
+        emit?: Record<string, string>;
     };
@@ -173,2 +167,10 @@ /**
     /**
+     * Returns the current date.
+     */
+    'date.now': unknown;
+    /**
+     * Adds to a date.
+     */
+    'date.add': string;
+    /**
      * Compare all computed remapper values against each other.
@@ -206,6 +208,8 @@ *
      */
-    'object.from': {
-        [key: string]: Remapper;
-    };
+    'object.from': Record<string, Remapper>;
     /**
+     * Assign properties to an existing object given some predefined mapper keys.
+     */
+    'object.assign': Record<string, Remapper>;
+    /**
      * Use a static value.
@@ -241,5 +245,3 @@ */
          */
-        values: {
-            [key: string]: Remapper;
-        };
+        values: Record<string, Remapper>;
     };
@@ -249,5 +251,3 @@ /**
      */
-    'string.replace': {
-        [regex: string]: string;
-    };
+    'string.replace': Record<string, string>;
     user: keyof UserInfo;
@@ -260,12 +260,8 @@ }
     delete: boolean;
-    subscriptions?: {
-        [id: string]: {
-            update: boolean;
-            delete: boolean;
-        };
-    };
+    subscriptions?: Record<string, {
+        update: boolean;
+        delete: boolean;
+    }>;
 }
-export interface SubscriptionResponse {
-    [type: string]: SubscriptionResponseResource;
-}
+export declare type SubscriptionResponse = Record<string, SubscriptionResponseResource>;
 export interface Security {
@@ -277,9 +273,7 @@ login?: 'password';
     };
-    roles: {
-        [role: string]: {
-            description?: string;
-            inherits?: string[];
-            defaultPage?: string;
-        };
-    };
+    roles: Record<string, {
+        description?: string;
+        inherits?: string[];
+        defaultPage?: string;
+    }>;
 }
@@ -318,5 +312,3 @@ export declare type Navigation = 'bottom' | 'left-menu' | 'hidden';
      */
-    query?: {
-        [key: string]: string;
-    };
+    query?: Record<string, string>;
     /**
@@ -383,5 +375,3 @@ * THe roles that are allowed to perform this action.
      */
-    references?: {
-        [property: string]: ResourceReference;
-    };
+    references?: Record<string, ResourceReference>;
     /**
@@ -479,5 +469,3 @@ * A time string representing when a resource should expire.
      */
-    parameters?: {
-        [key: string]: any;
-    };
+    parameters?: Record<string, any>;
 }
@@ -518,5 +506,3 @@ export interface LogActionDefinition extends BaseActionDefinition<'log'> {
      */
-    query?: {
-        [key: string]: string;
-    };
+    query?: Record<string, string>;
     /**
@@ -627,5 +613,3 @@ * The URL to which to make the request.
      */
-    actions?: {
-        [key: string]: ActionType;
-    };
+    actions?: Record<string, ActionType>;
     /**
@@ -635,8 +619,4 @@ * The events that are supported by a block.
     events?: {
-        listen?: {
-            [key: string]: EventType;
-        };
-        emit?: {
-            [key: string]: EventType;
-        };
+        listen?: Record<string, EventType>;
+        emit?: Record<string, EventType>;
     };
@@ -761,5 +741,3 @@ /**
      */
-    resources?: {
-        [key: string]: ResourceDefinition;
-    };
+    resources?: Record<string, ResourceDefinition>;
     /**
@@ -900,5 +878,3 @@ * The global theme for the app.
      */
-    messages: {
-        [messageId: string]: string;
-    };
+    messages: Record<string, string>;
 }
@@ -905,0 +881,0 @@ /**

package.json

 {
   "name": "@appsemble/types",
-  "version": "0.15.4",
+  "version": "0.15.5",
   "description": "TypeScript definitions reused within Appsemble internally",
@@ -31,7 +31,8 @@ "keywords": [
   "dependencies": {
-    "@appsemble/sdk": "0.15.4",
-    "@fortawesome/fontawesome-common-types": "^0.2.30",
+    "@appsemble/sdk": "0.15.5",
+    "@fortawesome/fontawesome-common-types": "^0.2.32",
     "openapi-types": "^7.0.1",
-    "type-fest": "^0.16.0"
+    "type-fest": "^0.18.0",
+    "typescript-json-schema": "^0.43.0"
   }
 }

src/index.ts

@@ -1,2 +0,2 @@
-import type {
+import {
   Action,
@@ -9,8 +9,8 @@ BaseMessage,
 } from '@appsemble/sdk/src/types';
-import type { IconName } from '@fortawesome/fontawesome-common-types';
-import type { OpenAPIV3 } from 'openapi-types';
-import type { JsonObject, RequireExactlyOne } from 'type-fest';
-import type { Definition } from 'typescript-json-schema';
+import { IconName } from '@fortawesome/fontawesome-common-types';
+import { OpenAPIV3 } from 'openapi-types';
+import { JsonObject, RequireExactlyOne } from 'type-fest';
+import { Definition } from 'typescript-json-schema';
 
-export type { Theme };
+export { Theme };
 
@@ -94,3 +94,3 @@ /**
    */
-  actions?: { [action: string]: ActionDefinition };
+  actions?: Record<string, ActionDefinition>;
 
@@ -103,4 +103,4 @@ /**
   events?: {
-    listen?: { [listener: string]: string };
-    emit?: { [emitter: string]: string };
+    listen?: Record<string, string>;
+    emit?: Record<string, string>;
   };
@@ -217,2 +217,12 @@
   /**
+   * Returns the current date.
+   */
+  'date.now': unknown;
+
+  /**
+   * Adds to a date.
+   */
+  'date.add': string;
+
+  /**
    * Compare all computed remapper values against each other.
@@ -250,7 +260,10 @@ *
    */
-  'object.from': {
-    [key: string]: Remapper;
-  };
+  'object.from': Record<string, Remapper>;
 
   /**
+   * Assign properties to an existing object given some predefined mapper keys.
+   */
+  'object.assign': Record<string, Remapper>;
+
+  /**
    * Use a static value.
@@ -292,5 +305,3 @@ */
      */
-    values: {
-      [key: string]: Remapper;
-    };
+    values: Record<string, Remapper>;
   };
@@ -301,5 +312,3 @@
    */
-  'string.replace': {
-    [regex: string]: string;
-  };
+  'string.replace': Record<string, string>;
 
@@ -320,13 +329,12 @@ user: keyof UserInfo;
   delete: boolean;
-  subscriptions?: {
-    [id: string]: {
+  subscriptions?: Record<
+    string,
+    {
       update: boolean;
       delete: boolean;
-    };
-  };
+    }
+  >;
 }
 
-export interface SubscriptionResponse {
-  [type: string]: SubscriptionResponseResource;
-}
+export type SubscriptionResponse = Record<string, SubscriptionResponseResource>;
 
@@ -339,9 +347,10 @@ export interface Security {
   };
-  roles: {
-    [role: string]: {
+  roles: Record<
+    string,
+    {
       description?: string;
       inherits?: string[];
       defaultPage?: string;
-    };
-  };
+    }
+  >;
 }
@@ -387,3 +396,3 @@
    */
-  query?: { [key: string]: string };
+  query?: Record<string, string>;
 
@@ -464,3 +473,3 @@ /**
    */
-  references?: { [property: string]: ResourceReference };
+  references?: Record<string, ResourceReference>;
 
@@ -577,3 +586,3 @@ /**
    */
-  parameters?: { [key: string]: any };
+  parameters?: Record<string, any>;
 }
@@ -623,3 +632,3 @@
    */
-  query?: { [key: string]: string };
+  query?: Record<string, string>;
 
@@ -791,3 +800,3 @@ /**
    */
-  actions?: { [key: string]: ActionType };
+  actions?: Record<string, ActionType>;
 
@@ -798,4 +807,4 @@ /**
   events?: {
-    listen?: { [key: string]: EventType };
-    emit?: { [key: string]: EventType };
+    listen?: Record<string, EventType>;
+    emit?: Record<string, EventType>;
   };
@@ -944,3 +953,3 @@
    */
-  resources?: { [key: string]: ResourceDefinition };
+  resources?: Record<string, ResourceDefinition>;
 
@@ -1112,3 +1121,3 @@ /**
    */
-  messages: { [messageId: string]: string };
+  messages: Record<string, string>;
 }
@@ -1115,0 +1124,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

50687

increased by0.11%

Worsened metrics

Dependency count

5

increased by25%

Lines of code

1940

decreased by-0.92%

Dependency changes

• + Addedtypescript-json-schema@^0.43.0

• + Added@appsemble/sdk@0.15.5(transitive)

• + Added@types/json-schema@7.0.15(transitive)

• + Addedansi-regex@5.0.1(transitive)

• + Addedansi-styles@4.3.0(transitive)

• + Addedbalanced-match@1.0.2(transitive)

• + Addedbrace-expansion@1.1.11(transitive)

• + Addedcall-bind@1.0.7(transitive)

• + Addedcamelcase@5.3.1(transitive)

• + Addedcliui@6.0.0(transitive)

• + Addedcolor-convert@2.0.1(transitive)

• + Addedcolor-name@1.1.4(transitive)

• + Addedconcat-map@0.0.1(transitive)

• + Addeddecamelize@1.2.0(transitive)

• + Addeddefine-data-property@1.1.4(transitive)

• + Addedemoji-regex@8.0.0(transitive)

• + Addedes-define-property@1.0.0(transitive)

• + Addedes-errors@1.3.0(transitive)

• + Addedfind-up@4.1.0(transitive)

• + Addedfs.realpath@1.0.0(transitive)

• + Addedfunction-bind@1.1.2(transitive)

• + Addedget-caller-file@2.0.5(transitive)

• + Addedget-intrinsic@1.2.4(transitive)

• + Addedglob@7.1.7(transitive)

• + Addedgopd@1.0.1(transitive)

• + Addedhas-property-descriptors@1.0.2(transitive)

• + Addedhas-proto@1.0.3(transitive)

• + Addedhas-symbols@1.0.3(transitive)

• + Addedhasown@2.0.2(transitive)

• + Addedinflight@1.0.6(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedis-fullwidth-code-point@3.0.0(transitive)

• + Addedisarray@2.0.5(transitive)

• + Addedjson-stable-stringify@1.1.1(transitive)

• + Addedjsonify@0.0.1(transitive)

• + Addedlocate-path@5.0.0(transitive)

• + Addedminimatch@3.1.2(transitive)

• + Addedobject-keys@1.1.1(transitive)

• + Addedonce@1.4.0(transitive)

• + Addedp-limit@2.3.0(transitive)

• + Addedp-locate@4.1.0(transitive)

• + Addedp-try@2.2.0(transitive)

• + Addedpath-exists@4.0.0(transitive)

• + Addedpath-is-absolute@1.0.1(transitive)

• + Addedrequire-directory@2.1.1(transitive)

• + Addedrequire-main-filename@2.0.0(transitive)

• + Addedset-blocking@2.0.0(transitive)

• + Addedset-function-length@1.2.2(transitive)

• + Addedstring-width@4.2.3(transitive)

• + Addedstrip-ansi@6.0.1(transitive)

• + Addedtype-fest@0.18.1(transitive)

• + Addedtypescript@4.0.8(transitive)

• + Addedtypescript-json-schema@0.43.0(transitive)

• + Addedwhich-module@2.0.1(transitive)

• + Addedwrap-ansi@6.2.0(transitive)

• + Addedwrappy@1.0.2(transitive)

• + Addedy18n@4.0.3(transitive)

• + Addedyargs@15.4.1(transitive)

• + Addedyargs-parser@18.1.3(transitive)

• - Removed@appsemble/sdk@0.15.4(transitive)

• - Removedtype-fest@0.16.0(transitive)

• Updated@appsemble/sdk@0.15.5

• Updated@fortawesome/fontawesome-common-types@^0.2.32

• Updatedtype-fest@^0.18.0