@shopify/ui-extensions-server-kit 0.0.0-snapshot-20240814205424

package/dist/types.d.ts

@@ -0,0 +1,173 @@
+import { FlattenedLocalization, Localization } from './i18n';
+import './ExtensionServerClient/types';
+import type { Surface } from './ExtensionServerClient/types';
+declare global {
+    namespace ExtensionServer {
+        type ServerEvents = {
+            event: 'dispatch';
+            data: InboundEvents['dispatch'];
+        } | {
+            event: 'connected';
+            data: InboundEvents['connected'];
+        } | {
+            event: 'update';
+            data: InboundEvents['update'];
+        };
+        interface InboundEvents extends DispatchEvents {
+            dispatch: {
+                type: keyof DispatchEvents;
+                payload: DispatchEvents[keyof DispatchEvents];
+            };
+            connected: {
+                extensions: ExtensionPayload[];
+                app?: App;
+                store: string;
+            };
+            update: {
+                extensions?: ExtensionPayload[];
+                app?: App;
+            };
+        }
+        interface OutboundPersistEvents {
+            update: {
+                extensions?: ({
+                    uuid: string;
+                } & DeepPartial<ExtensionPayload>)[];
+                app?: DeepPartial<App>;
+            };
+        }
+        interface DispatchEvents {
+            refresh: {
+                uuid: string;
+            }[];
+            focus: {
+                uuid: string;
+            }[];
+            unfocus: void;
+            navigate: {
+                url: string;
+            };
+        }
+        namespace API {
+            interface BaseResponse {
+                app: App;
+                root: ResourceURL;
+                socket: ResourceURL;
+                devConsole: ResourceURL;
+                store: string;
+                version: string;
+            }
+            interface ExtensionsResponse extends BaseResponse {
+                extensions: ExtensionPayload[];
+            }
+            interface ExtensionResponse extends BaseResponse {
+                extension: ExtensionPayload;
+            }
+        }
+        interface UIExtension extends ExtensionPayload {
+            extensionPoints: ExtensionPoint[];
+            apiVersion: string;
+        }
+    }
+}
+export type DeepPartial<T> = {
+    [P in keyof T]?: DeepPartial<T[P]>;
+};
+export interface ResourceURL {
+    url: string;
+}
+export interface Asset extends ResourceURL {
+    name: string;
+    lastUpdated: number;
+}
+export interface Metafield {
+    namespace: string;
+    key: string;
+}
+export interface ExtensionPoint {
+    target: string;
+    surface: Surface;
+    metafields?: Metafield[];
+    resource: ResourceURL;
+    root: ResourceURL;
+    localization?: FlattenedLocalization | Localization | null;
+    name: string;
+    description?: string;
+}
+export type ExtensionPoints = string[] | ExtensionPoint[] | null;
+interface CollectBuyerConsentCapabilities {
+    smsMarketing: boolean;
+    customerPrivacy: boolean;
+}
+interface IframeCapabilities {
+    sources: string[];
+}
+interface Capabilities {
+    apiAccess: boolean;
+    blockProgress: boolean;
+    networkAccess: boolean;
+    collectBuyerConsent: CollectBuyerConsentCapabilities;
+    iframe: IframeCapabilities;
+}
+export interface ExtensionPayload {
+    type: string;
+    externalType: string;
+    assets: {
+        [name: string]: Asset;
+    };
+    development: {
+        hidden: boolean;
+        status: Status;
+        focused?: boolean;
+        resource: ResourceURL;
+        root: ResourceURL;
+        renderer: {
+            name: string;
+            version: string;
+        };
+    };
+    uuid: string;
+    version: string;
+    surface: Surface;
+    name: string;
+    description?: string;
+    handle: string;
+    extensionPoints: ExtensionPoints;
+    capabilities?: Capabilities;
+    authenticatedRedirectStartUrl?: string;
+    authenticatedRedirectRedirectUrls?: string[];
+    localization?: FlattenedLocalization | Localization | null;
+    settings?: {
+        fields?: {
+            type: string;
+            key?: string;
+            name?: string;
+            description?: string;
+            required?: boolean;
+            validations?: any[];
+        }[];
+    };
+}
+export declare enum Status {
+    Error = "error",
+    Success = "success"
+}
+export interface App {
+    id: string;
+    apiKey: string;
+    url: string;
+    mobileUrl: string;
+    applicationUrl: string;
+    handle?: string | null;
+    title: string;
+    developerName?: string;
+    icon: {
+        transformedSrc: string;
+    };
+    installation?: {
+        launchUrl: string;
+    };
+    supportEmail?: string;
+    supportLocales?: string[];
+}
+export {};

package/dist/types.es.js

@@ -0,0 +1,4 @@
+var e = /* @__PURE__ */ ((r) => (r.Error = "error", r.Success = "success", r))(e || {});
+export {
+  e as Status
+};

package/dist/utilities/assetToString.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function r(t){const e=new URL(t.url);return e.searchParams.set("lastUpdated",String(t.lastUpdated)),e.toString()}exports.assetToString=r;

package/dist/utilities/assetToString.d.ts

@@ -0,0 +1,2 @@
+import type { Asset } from '../types';
+export declare function assetToString(asset: Asset): string;

package/dist/utilities/assetToString.es.js

@@ -0,0 +1,7 @@
+function n(t) {
+  const r = new URL(t.url);
+  return r.searchParams.set("lastUpdated", String(t.lastUpdated)), r.toString();
+}
+export {
+  n as assetToString
+};

package/dist/utilities/assetToString.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utilities/groupByKey.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function t(r,o){return new Map(o.map(e=>[e[r],e]))}exports.groupByKey=t;

package/dist/utilities/groupByKey.d.ts

@@ -0,0 +1,3 @@
+export declare function groupByKey<T extends {
+    [key: string]: unknown;
+}>(key: keyof T, items: T[]): Map<T[keyof T], T>;

package/dist/utilities/groupByKey.es.js

@@ -0,0 +1,6 @@
+function e(p, r) {
+  return new Map(r.map((n) => [n[p], n]));
+}
+export {
+  e as groupByKey
+};

package/dist/utilities/index.d.ts

@@ -0,0 +1,7 @@
+export * from './groupByKey';
+export * from './noop';
+export * from './replaceUpdated';
+export * from './set';
+export * from './assetToString';
+export * from './isValidSurface';
+export * from './isUIExtension';

package/dist/utilities/isUIExtension.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function i(e){return e.type==="ui_extension"&&Array.isArray(e.extensionPoints)&&e.extensionPoints.every(t=>typeof t=="object")}exports.isUIExtension=i;

package/dist/utilities/isUIExtension.d.ts

@@ -0,0 +1 @@
+export declare function isUIExtension(extension: any): extension is ExtensionServer.UIExtension;

package/dist/utilities/isUIExtension.es.js

@@ -0,0 +1,6 @@
+function n(e) {
+  return e.type === "ui_extension" && Array.isArray(e.extensionPoints) && e.extensionPoints.every((t) => typeof t == "object");
+}
+export {
+  n as isUIExtension
+};

package/dist/utilities/isValidSurface.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const i=require("../ExtensionServerClient/types.cjs.js");function t(e){return e&&i.AVAILABLE_SURFACES.includes(e)}exports.isValidSurface=t;

package/dist/utilities/isValidSurface.d.ts

@@ -0,0 +1,2 @@
+import type { Surface } from '../ExtensionServerClient/types';
+export declare function isValidSurface(surface: any): surface is Surface;

package/dist/utilities/isValidSurface.es.js

@@ -0,0 +1,7 @@
+import { AVAILABLE_SURFACES as r } from "../ExtensionServerClient/types.es.js";
+function o(i) {
+  return i && r.includes(i);
+}
+export {
+  o as isValidSurface
+};

package/dist/utilities/noop.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const o=()=>{};exports.noop=o;

package/dist/utilities/noop.d.ts

@@ -0,0 +1 @@
+export declare const noop: () => void;

package/dist/utilities/noop.es.js

@@ -0,0 +1,5 @@
+const o = () => {
+};
+export {
+  o as noop
+};

package/dist/utilities/replaceUpdated.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function u(n,p,d){const t=new Map(p.map(e=>[d(e),e]));return[...n.map(e=>{const a=d(e);if(t.has(a)){const r=t.get(a);return t.delete(a),r}else return e}),...t.values()]}exports.replaceUpdated=u;

package/dist/utilities/replaceUpdated.d.ts

@@ -0,0 +1 @@
+export declare function replaceUpdated<T>(arr: T[], updates: T[], cb: (v: T) => unknown): T[];

package/dist/utilities/replaceUpdated.es.js

@@ -0,0 +1,14 @@
+function u(p, d, n) {
+  const t = new Map(d.map((e) => [n(e), e]));
+  return [...p.map((e) => {
+    const a = n(e);
+    if (t.has(a)) {
+      const r = t.get(a);
+      return t.delete(a), r;
+    } else
+      return e;
+  }), ...t.values()];
+}
+export {
+  u as replaceUpdated
+};

package/dist/utilities/replaceUpdated.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utilities/set.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function l(s,c,u){const o=[],n=new Proxy({},{get:(e,y)=>(o.push(y),n)});c(n);const r={...s};let t=r;const p=o.pop();for(const e of o)t[e]={...t[e]},t=t[e];return t[p]=u,r}exports.set=l;

package/dist/utilities/set.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Deep sets an object in a type-safe way
+ */
+export declare function set<TObject, TValue>(obj: TObject, pathFn: (o: TObject) => TValue, value: TValue): TObject;

package/dist/utilities/set.es.js

@@ -0,0 +1,18 @@
+function f(s, c, p) {
+  const o = [], e = new Proxy(
+    {},
+    {
+      get: (n, y) => (o.push(y), e)
+    }
+  );
+  c(e);
+  const r = { ...s };
+  let t = r;
+  const u = o.pop();
+  for (const n of o)
+    t[n] = { ...t[n] }, t = t[n];
+  return t[u] = p, r;
+}
+export {
+  f as set
+};

package/dist/utilities/set.test.d.ts

@@ -0,0 +1 @@
+export {};

package/index.d.ts

@@ -0,0 +1 @@
+export * from './dist';

package/index.js

@@ -0,0 +1 @@
+module.exports = require('./dist/index.cjs');

package/index.mjs

@@ -0,0 +1 @@
+export * from './dist/index.es.js';

package/node_modules/@shopify/react-testing/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018-present Shopify
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.