@wix/auto_sdk_motion_alarms 1.0.0

package/build/internal/es/src/alarm-v1-alarm-alarms.universal.d.ts

@@ -0,0 +1,322 @@
+export interface AlarmMessage {
+    _id?: string;
+    seconds?: number;
+}
+export interface Dispatched {
+    /** the message someone says */
+    echo?: EchoMessage;
+}
+export interface EchoMessage {
+    /** message comment from EchoMessage proto def, with special comment */
+    message?: string;
+    /** messages_list comment from EchoMessage proto def */
+    messagesList?: MessageItem[];
+    _id?: string;
+}
+export interface MessageItem {
+    /** inner_message comment from EchoMessage proto def */
+    innerMessage?: string;
+}
+export interface AlarmTestRequest {
+}
+export interface AlarmTestResponse {
+}
+export interface AlarmRequest {
+    seconds: number;
+    someString?: string;
+    someOtherString?: string;
+    someOtherField?: string;
+}
+export interface AlarmResponse {
+    time?: Date | null;
+}
+export interface AlarmTriggered {
+}
+export interface AlarmSnoozed {
+}
+export interface AlarmDeleted {
+}
+export interface UpdateAlarmRequest {
+    alarm: AlarmMessage;
+}
+export interface UpdateAlarmResponse {
+    alarm?: AlarmMessage;
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entity?: string;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntity?: string | null;
+}
+export interface ActionEvent {
+    body?: string;
+}
+export interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+export interface AlarmRequestRequiredFields {
+    seconds: number;
+}
+export interface UpdateAlarmRequestRequiredFields {
+    alarm: {
+        _id: string;
+    };
+}
+interface AlarmMessageNonNullableFields {
+    _id: string;
+    seconds: number;
+}
+export interface UpdateAlarmResponseNonNullableFields {
+    alarm?: AlarmMessageNonNullableFields;
+}
+export interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+export interface EventMetadata extends BaseEventMetadata {
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+export interface AlarmDeletedEnvelope {
+    data: AlarmDeleted;
+    metadata: EventMetadata;
+}
+/**
+ * alarm event that might be consumed when alarm is deleted
+ * @permissionId METRO.ALARM.MANAGE
+ * @webhook
+ * @eventType wix.alarm.v1.alarm_alarm_deleted
+ * @serviceIdentifier wix.coreservices.alarm.v1.AlarmService
+ * @slug alarm_deleted
+ */
+export declare function onAlarmDeleted(handler: (event: AlarmDeletedEnvelope) => void | Promise<void>): void;
+export interface AlarmSnoozedEnvelope {
+    data: AlarmSnoozed;
+    metadata: EventMetadata;
+}
+/**
+ * alarm event that might be consumed when alarm is snoozed
+ * @permissionId METRO.ALARM.MANAGE
+ * @webhook
+ * @eventType wix.alarm.v1.alarm_alarm_snoozed
+ * @serviceIdentifier wix.coreservices.alarm.v1.AlarmService
+ * @slug alarm_snoozed
+ */
+export declare function onAlarmSnoozed(handler: (event: AlarmSnoozedEnvelope) => void | Promise<void>): void;
+export interface AlarmTriggeredEnvelope {
+    data: AlarmTriggered;
+    metadata: EventMetadata;
+}
+/**
+ * alarm event that might be consumed when alarm is triggered
+ * @permissionId METRO.ALARM.MANAGE
+ * @webhook
+ * @eventType wix.alarm.v1.alarm_alarm_triggered
+ * @serviceIdentifier wix.coreservices.alarm.v1.AlarmService
+ * @slug alarm_triggered
+ */
+export declare function onAlarmTriggered(handler: (event: AlarmTriggeredEnvelope) => void | Promise<void>): void;
+/**
+ * Some description
+ * @public
+ * @permissionId METRO.ALARM_TEST_FAKE
+ * @fqn wix.coreservices.alarm.v1.AlarmService.AlarmTest
+ */
+export declare function alarmTest(): Promise<void>;
+/**
+ * sets up an alarm after {seconds}
+ * @public
+ * @requiredField seconds
+ * @fqn wix.coreservices.alarm.v1.AlarmService.Alarm
+ */
+export declare function alarm(seconds: number, options?: AlarmOptions): Promise<AlarmResponse>;
+export interface AlarmOptions {
+    someString?: string;
+    someOtherString?: string;
+    someOtherField?: string;
+}
+/**
+ * sets up an existing alarm with id {id}
+ * @public
+ * @requiredField _id
+ * @requiredField alarm
+ * @fqn wix.coreservices.alarm.v1.AlarmService.UpdateAlarm
+ */
+export declare function updateAlarm(_id: string, alarm: UpdateAlarm): Promise<UpdateAlarmResponse & UpdateAlarmResponseNonNullableFields>;
+export interface UpdateAlarm {
+    _id?: string;
+    seconds?: number;
+}
+export {};

package/build/internal/es/src/alarm-v1-alarm-alarms.universal.js

@@ -0,0 +1,105 @@
+import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
+import { renameKeysFromSDKRequestToRESTRequest, renameKeysFromRESTResponseToSDKResponse, } from '@wix/sdk-runtime/rename-all-nested-keys';
+import * as ambassadorWixAlarmV1Alarm from './alarm-v1-alarm-alarms.http.js';
+export var WebhookIdentityType;
+(function (WebhookIdentityType) {
+    WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
+    WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+    WebhookIdentityType["MEMBER"] = "MEMBER";
+    WebhookIdentityType["WIX_USER"] = "WIX_USER";
+    WebhookIdentityType["APP"] = "APP";
+})(WebhookIdentityType || (WebhookIdentityType = {}));
+/**
+ * Some description
+ * @public
+ * @permissionId METRO.ALARM_TEST_FAKE
+ * @fqn wix.coreservices.alarm.v1.AlarmService.AlarmTest
+ */
+export async function alarmTest() {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[0];
+    const payload = renameKeysFromSDKRequestToRESTRequest({});
+    const reqOpts = ambassadorWixAlarmV1Alarm.alarmTest(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+    }
+    catch (err) {
+        const transformedError = sdkTransformError(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: {},
+            singleArgumentUnchanged: false,
+        }, []);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+/**
+ * sets up an alarm after {seconds}
+ * @public
+ * @requiredField seconds
+ * @fqn wix.coreservices.alarm.v1.AlarmService.Alarm
+ */
+export async function alarm(seconds, options) {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[2];
+    const payload = renameKeysFromSDKRequestToRESTRequest({
+        seconds: seconds,
+        someString: options?.someString,
+        someOtherString: options?.someOtherString,
+        someOtherField: options?.someOtherField,
+    });
+    const reqOpts = ambassadorWixAlarmV1Alarm.alarm(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+        return renameKeysFromRESTResponseToSDKResponse(result.data);
+    }
+    catch (err) {
+        const transformedError = sdkTransformError(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: {
+                seconds: '$[0]',
+                someString: '$[1].someString',
+                someOtherString: '$[1].someOtherString',
+                someOtherField: '$[1].someOtherField',
+            },
+            singleArgumentUnchanged: false,
+        }, ['seconds', 'options']);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+/**
+ * sets up an existing alarm with id {id}
+ * @public
+ * @requiredField _id
+ * @requiredField alarm
+ * @fqn wix.coreservices.alarm.v1.AlarmService.UpdateAlarm
+ */
+export async function updateAlarm(_id, alarm) {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[2];
+    const payload = renameKeysFromSDKRequestToRESTRequest({
+        alarm: { ...alarm, id: _id },
+    });
+    const reqOpts = ambassadorWixAlarmV1Alarm.updateAlarm(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+        return renameKeysFromRESTResponseToSDKResponse(result.data);
+    }
+    catch (err) {
+        const transformedError = sdkTransformError(err, {
+            spreadPathsToArguments: { alarm: '$[1]' },
+            explicitPathsToArguments: { 'alarm.id': '$[0]' },
+            singleArgumentUnchanged: false,
+        }, ['_id', 'alarm']);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+//# sourceMappingURL=alarm-v1-alarm-alarms.universal.js.map

package/build/internal/es/src/alarm-v1-alarm-alarms.universal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"alarm-v1-alarm-alarms.universal.js","sourceRoot":"","sources":["../../../../src/alarm-v1-alarm-alarms.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,yBAAyB,MAAM,iCAAiC,CAAC;AAqM7E,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B;AA4HD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS;IAC7B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GAAG,yBAAyB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAE7D,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CACzB,OAAe,EACf,OAAsB;IAEtB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,OAAO,EAAE,OAAO;QAChB,UAAU,EAAE,OAAO,EAAE,UAAU;QAC/B,eAAe,EAAE,OAAO,EAAE,eAAe;QACzC,cAAc,EAAE,OAAO,EAAE,cAAc;KACxC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,yBAAyB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAEzD,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE;gBACxB,OAAO,EAAE,MAAM;gBACf,UAAU,EAAE,iBAAiB;gBAC7B,eAAe,EAAE,sBAAsB;gBACvC,cAAc,EAAE,qBAAqB;aACtC;YACD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,SAAS,EAAE,SAAS,CAAC,CACvB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAQD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,GAAW,EACX,KAAkB;IAElB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,KAAK,EAAE,EAAE,GAAG,KAAK,EAAE,EAAE,EAAE,GAAG,EAAE;KAC7B,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,yBAAyB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAE/D,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE;YACzC,wBAAwB,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE;YAChD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,KAAK,EAAE,OAAO,CAAC,CACjB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}

package/meta/package.json

@@ -0,0 +1,3 @@
+{
+  "main": "../build/cjs/meta.js"
+}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@wix/auto_sdk_motion_alarms",
+  "version": "1.0.0",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "keywords": [],
+  "sideEffects": false,
+  "main": "./build/cjs/index.js",
+  "types": "./build/es/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./build/es/index.js",
+      "require": "./build/cjs/index.js",
+      "types": "./build/es/index.d.ts"
+    },
+    "./package.json": "./package.json",
+    "./meta": {
+      "import": "./build/es/meta.js",
+      "require": "./build/cjs/meta.js",
+      "types": "./build/es/meta.d.ts"
+    }
+  },
+  "files": [
+    "build",
+    "meta",
+    "service-plugins"
+  ],
+  "dependencies": {
+    "@wix/sdk-runtime": "^0.3.35",
+    "@wix/sdk-types": "^1.12.4"
+  },
+  "devDependencies": {
+    "typescript": "^5.3.2"
+  },
+  "scripts": {
+    "build": "tsc -b tsconfig.json tsconfig.esm.json tsconfig.internal.json tsconfig.internal.esm.json",
+    "test": ":"
+  },
+  "wix": {
+    "artifact": {
+      "artifactId": "auto-sdk-motion-alarms",
+      "groupId": "com.wixpress.public-sdk-dependencies"
+    },
+    "sdkDependency": {
+      "fqdnNamespace": "alarms",
+      "fqdn": "wix.alarm.v1.alarm"
+    }
+  },
+  "falconPackageHash": "9b0793af35fb05f2a08ef02cae52906d151409d6aa846bc4c331ab7f"
+}