@kustomer/apps-common - npm Package Compare versions

Comparing version 0.5.4 to 0.5.5

dist/api/command.d.ts

@@ -7,3 +7,3 @@ import { APIBase, APIBaseOptions } from './base';
      */
-    run<B = any, R = any>(name: string, body?: B): Promise<R>;
+    run<B = unknown, R = unknown>(name: string, body?: B): Promise<R>;
 }

dist/api/customer.d.ts

@@ -24,7 +24,3 @@ import { WithID } from '../common';
         avatarUrl?: string | undefined;
-        locale?: string | undefined; /**
-         * get a customer by phone
-         * @param phone customer phone (unique)
-         * @returns
-         */
+        locale?: string | undefined;
         timeZone?: string | undefined;
@@ -46,3 +42,3 @@ tags?: string[] | undefined;
         dedicatedUser?: string | undefined;
-        custom?: any;
+        custom?: unknown;
         birthdayAt?: Date | undefined;
@@ -84,3 +80,3 @@ signedUpAt?: Date | undefined;
      */
-    createKObject<T = any>(id: string, klass: string, object: KObject<T>): Promise<WithID<KObject>>;
+    createKObject<T = unknown>(id: string, klass: string, object: KObject<T>): Promise<WithID<KObject>>;
 }

dist/api/org.d.ts

@@ -10,3 +10,3 @@ import { Org } from '../models';
 import { Commands } from './command';
-export declare class Orgs<KAppSettings = any> extends APIBase {
+export declare class Orgs<KAppSettings = unknown> extends APIBase {
     readonly customers: Customers;
@@ -13,0 +13,0 @@ readonly commands: Commands;

dist/api/settings.d.ts

 import { APIBase, APIBaseOptions } from './base';
-export declare class Settings<T = any> extends APIBase {
+export declare class Settings<T = unknown> extends APIBase {
     constructor(token: string, orgNameOrId: string, options: APIBaseOptions);
     /**
-     * get your apps settings
+     * Get application settings from an API endpoint and reshape the data into a nested object.
      */
@@ -7,0 +7,0 @@ get(): Promise<T>;

dist/common/json-schema.d.ts

@@ -10,3 +10,3 @@ export type JSONSchemaType = 'null' | 'boolean' | 'object' | 'array' | 'number' | 'string' | 'object';
     readonly description?: string;
-    readonly enum?: any[];
+    readonly enum?: unknown[];
     readonly maximum?: number;
@@ -13,0 +13,0 @@ readonly minimum?: number;

dist/common/response.d.ts

@@ -1,5 +0,5 @@
-export interface Response<T = any> {
+export interface Response<T = unknown> {
     readonly data: ResponseData<T>;
 }
-export interface ResponseData<T = any> {
+export interface ResponseData<T = unknown> {
     readonly type: string;
@@ -6,0 +6,0 @@ readonly id: string;

dist/components/action.d.ts

@@ -17,7 +17,7 @@ import { JSONSchema } from '../common';
     /** A definition for the shape of the data being passed into the action */
-    inputTemplate: Record<string, any>;
+    inputTemplate: Record<string, unknown>;
     /** A JSON schema used to validate the actions output data */
     outputSchema?: JSONSchema;
     /** A definition for the shape of the data that will leave the action, to be used in the next step of the workflow */
-    outputTemplate: Record<string, any>;
+    outputTemplate: Record<string, unknown>;
 }

dist/components/command.d.ts

 import { HttpMethod, JSONSchema } from '../common';
 export type CommandType = 'external-api';
-export type CommandCallback = (orgId: string, userId: string, data: any) => any;
+export type CommandCallback<D = unknown, R = unknown> = (orgId: string, userId: string, data: D) => Promise<R>;
 export interface CommandOptions {
@@ -21,6 +21,6 @@ /** create an action for this command to be used in workflows */
     httpMethod: HttpMethod;
-    defaultHeaders?: any;
-    defaultBody?: any;
+    defaultHeaders?: unknown;
+    defaultBody?: unknown;
     inputSchema?: JSONSchema | Record<string, JSONSchema>;
     outputSchema?: JSONSchema | Record<string, JSONSchema>;
 }

dist/components/conversation-actions.d.ts

@@ -31,7 +31,7 @@ export interface ConversationActions {
         operator: 'append' | 'replace' | 'remove';
-        value: any[];
+        value: unknown[];
     };
     assignedToTeams: {
         operator: 'append' | 'replace' | 'remove';
-        value: any[];
+        value: unknown[];
     };
@@ -38,0 +38,0 @@ custom: {

dist/components/settings.d.ts

@@ -15,3 +15,3 @@ /** The supported type of the given setting */
 }
-export interface Setting<T = any> extends SettingManifest {
+export interface Setting<T = unknown> extends SettingManifest {
     /** The name of the given setting */
@@ -18,0 +18,0 @@ name: string;

dist/components/shortcut.d.ts

@@ -11,3 +11,3 @@ import { ConversationActions } from './conversation-actions';
     };
-    payload: any;
+    payload: unknown;
     accessTeams: string[];
@@ -14,0 +14,0 @@ accessUsers: string[];

dist/logger/logger.d.ts

 import debug from 'debug';
 export interface KLogger {
-    info: (...args: any[]) => void;
-    warn: (...args: any[]) => void;
-    error: (...args: any[]) => void;
+    info: debug.Debugger;
+    warn: debug.Debugger;
+    error: debug.Debugger;
 }
@@ -7,0 +7,0 @@ /**

dist/models/conversation.d.ts

@@ -11,3 +11,3 @@ export type ConversationStatus = 'open' | 'snoozed' | 'done';
 }
-export interface ConversationLastMessageIn<T = any> {
+export interface ConversationLastMessageIn<T = unknown> {
     readonly id: string;
@@ -25,3 +25,3 @@ readonly channel?: string;
 }
-export interface Conversation<T = any> {
+export interface Conversation<T = unknown> {
     readonly name: string;
@@ -28,0 +28,0 @@ readonly externalId?: string;

dist/models/customer.d.ts

@@ -57,3 +57,3 @@ export interface Email {
 }
-export interface Customer<T = any> {
+export interface Customer<T = unknown> {
     readonly rev?: number;
@@ -95,3 +95,3 @@ name?: string;
 }
-export interface CustomerCreate<T = any> {
+export interface CustomerCreate<T = unknown> {
     name?: string;
@@ -124,3 +124,3 @@ company?: string;
 }
-export interface CustomerUpdate<T = any> {
+export interface CustomerUpdate<T = unknown> {
     name?: string;
@@ -127,0 +127,0 @@ company?: string;

dist/models/kobject.d.ts

@@ -1,2 +0,2 @@
-export interface KObject<T = any, D = any> {
+export interface KObject<T = unknown, D = unknown> {
     readonly title: string;
@@ -19,3 +19,3 @@ readonly description?: string;
 }
-export interface KObjectCreate<T = any, D = any> {
+export interface KObjectCreate<T = unknown, D = unknown> {
     title?: string;
@@ -22,0 +22,0 @@ description?: string;

dist/models/message.d.ts

@@ -9,3 +9,3 @@ export type MessageChannel = 'email' | 'sms' | 'whatsapp' | 'chat' | 'facebook' | 'facebook-wallpost' | 'twitter-dm' | 'twitter-tweet' | 'voice' | 'instagram' | 'instagram-comment' | 'form' | 'sendbird-chat' | 'portal';
 }
-export interface Message<M = any, C = any, E = any> {
+export interface Message<M = unknown, C = unknown, E = unknown> {
     readonly externalId?: string;
@@ -12,0 +12,0 @@ readonly app?: string;

dist/models/org.d.ts

@@ -1,2 +0,2 @@
-export interface Org<Meta = any> {
+export interface Org<Meta = unknown> {
     readonly meta: Meta;
@@ -3,0 +3,0 @@ readonly name: string;

dist/utils/apply-mixins.d.ts

@@ -1,1 +0,3 @@
-export declare function applyMixins(derivedCtor: any, constructors: any[]): void;
+type Constructor<T = Record<string, any>> = new (...args: any[]) => T;
+export declare function applyMixins(derivedCtor: Constructor, constructors: Constructor[]): void;
+export {};

package.json

 {
   "name": "@kustomer/apps-common",
-  "version": "0.5.4",
+  "version": "0.5.5",
   "license": "MIT",
@@ -5,0 +5,0 @@ "repository": {

No alert changes

Improved metrics

Total package byte prevSize

241446

increased by3.12%

Number of package files

297

increased by1.71%

Lines of code

3899

increased by2.69%

No dependency changes