@wix/site-service-lightbox 0.0.0-stage → 1.0.0

package/README.md

@@ -1,3 +1,76 @@
-# Temporary Holding Version
+# @wix/site-service-lightbox
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Opens and closes **lightboxes** (popups) and reads the context the open lightbox was
+opened with. Only one lightbox is open at a time. UI & Viewport category.
+
+## Install
+
+```sh
+yarn add @wix/site-service-lightbox
+```
+
+## Usage
+
+```ts
+import { LightboxDefinition } from '@wix/site-service-lightbox/definition'
+
+const lightbox = useService(LightboxDefinition)
+
+type SignupContext = { source: string }
+
+// Open a lightbox page, passing it some context:
+await lightbox.open<SignupContext>({ pageId: 'lightbox-page-id', context: { source: 'signup' } })
+
+// In a component rendered inside the lightbox:
+const context = lightbox.getContext<SignupContext>()
+lightbox.close()
+```
+
+The host (Thunderbolt) registers the service and injects the actual behavior:
+
+```ts
+import { LightboxDefinition } from '@wix/site-service-lightbox/definition'
+import { LightboxService } from '@wix/site-service-lightbox/implementations'
+
+createServicesMap().addService(LightboxDefinition, LightboxService, {
+	open: async ({ pageId, context }) => {
+		/* open the lightbox page */
+	},
+	close: () => {
+		/* close the open lightbox */
+	},
+	getContext: () => {
+		/* return the open lightbox's context */
+	},
+})
+```
+
+## API
+
+| Member | Type | Description |
+|---|---|---|
+| `open` | `<TContext = LightboxContext>(options: { pageId: string; context?: TContext }) => Promise<void>` | Opens the lightbox page `pageId` with `context`. Returns the host's promise. |
+| `close` | `() => void` | Closes the currently open lightbox. Fire-and-forget: returns nothing, even if the host's close is async. |
+| `getContext` | `<TContext = LightboxContext>() => TContext` | Returns the context the open lightbox was opened with. |
+
+All three are plain methods — this service exposes no property getters.
+
+The context is opaque to the service: it passes the value through unchanged and never reads it
+(`LightboxContext` is `unknown`).
+`TContext` types it for the caller, but nothing checks that `getContext<TContext>()` asks for
+the same type the lightbox was opened with; that is the caller's assertion.
+
+## Configuration
+
+`ILightboxServiceConfig`:
+
+```ts
+export type ILightboxServiceConfig = {
+	open: (options: LightboxOpenOptions) => Promise<void>
+	close: () => void
+	getContext: () => LightboxContext
+}
+```
+
+- `open`, `close`, `getContext` — the host's implementations. The service calls them on each use.
+  All three are required; the service has no fallback behavior.

package/cjs/build/definition/index.d.ts

@@ -0,0 +1,23 @@
+import type { ServiceDefinition } from '@wix/services-definitions';
+export type LightboxContext = unknown;
+export type LightboxOpenOptions<TContext = LightboxContext> = {
+    pageId: string;
+    context?: TContext;
+};
+export type ILightboxServiceConfig = {
+    open: (options: LightboxOpenOptions) => Promise<void>;
+    close: () => void;
+    getContext: () => LightboxContext;
+};
+export interface ILightboxService {
+    open<TContext = LightboxContext>(options: LightboxOpenOptions<TContext>): Promise<void>;
+    close(): void;
+    /** Not checked against the context passed to `open`; the caller asserts its type. */
+    getContext<TContext = LightboxContext>(): TContext;
+}
+export type ILightboxDefinition = ServiceDefinition<ILightboxService, ILightboxServiceConfig>;
+export declare const LightboxDefinition: string & {
+    __api: ILightboxService;
+    __config: ILightboxServiceConfig;
+    isServiceDefinition?: boolean;
+} & ILightboxService;

package/cjs/build/definition/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LightboxDefinition = void 0;
+const services_definitions_1 = require("@wix/services-definitions");
+exports.LightboxDefinition = (0, services_definitions_1.defineService)('@wix/site-service-lightbox');
+//# sourceMappingURL=index.js.map

package/cjs/build/definition/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/definition/index.ts"],"names":[],"mappings":";;;AAAA,oEAAyD;AAyB5C,QAAA,kBAAkB,GAAG,IAAA,oCAAa,EAA2C,4BAA4B,CAAC,CAAA"}

package/cjs/build/implementations/index.d.ts

@@ -0,0 +1 @@
+export { LightboxService } from './lightboxService';

package/cjs/build/implementations/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LightboxService = void 0;
+var lightboxService_1 = require("./lightboxService");
+Object.defineProperty(exports, "LightboxService", { enumerable: true, get: function () { return lightboxService_1.LightboxService; } });
+//# sourceMappingURL=index.js.map

package/cjs/build/implementations/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/implementations/index.ts"],"names":[],"mappings":";;;AAAA,qDAAmD;AAA1C,kHAAA,eAAe,OAAA"}

package/cjs/build/implementations/lightboxService.d.ts

@@ -0,0 +1,6 @@
+import type { ILightboxService, ILightboxServiceConfig } from '../definition';
+export declare const LightboxService: import("@wix/services-definitions").ServiceFactory<string & {
+    __api: ILightboxService;
+    __config: ILightboxServiceConfig;
+    isServiceDefinition?: boolean;
+} & ILightboxService, ILightboxServiceConfig>;

package/cjs/build/implementations/lightboxService.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LightboxService = void 0;
+const services_definitions_1 = require("@wix/services-definitions");
+const definition_1 = require("../definition");
+exports.LightboxService = (0, services_definitions_1.implementService)(definition_1.LightboxDefinition, ({ config }) => {
+    return {
+        open: (options) => config.open(options),
+        close: () => {
+            config.close();
+        },
+        getContext: () => config.getContext(),
+    };
+});
+//# sourceMappingURL=lightboxService.js.map

package/cjs/build/implementations/lightboxService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lightboxService.js","sourceRoot":"","sources":["../../../src/implementations/lightboxService.ts"],"names":[],"mappings":";;;AAAA,oEAA4D;AAG5D,8CAAkD;AAErC,QAAA,eAAe,GAAG,IAAA,uCAAgB,EAC9C,+BAAkB,EAClB,CAAC,EAAE,MAAM,EAA8C,EAAoB,EAAE;IAC5E,OAAO;QACN,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;QACvC,KAAK,EAAE,GAAG,EAAE;YACX,MAAM,CAAC,KAAK,EAAE,CAAA;QACf,CAAC;QACD,UAAU,EAAE,GAAa,EAAE,CAAC,MAAM,CAAC,UAAU,EAAc;KAC3D,CAAA;AACF,CAAC,CACD,CAAA"}

package/cjs/build/index.d.ts

@@ -0,0 +1,2 @@
+export * from './definition';
+export * from './implementations';

package/cjs/build/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./definition"), exports);
+__exportStar(require("./implementations"), exports);
+//# sourceMappingURL=index.js.map

package/cjs/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA4B;AAC5B,oDAAiC"}

package/cjs/build/service.d.ts

@@ -0,0 +1,7 @@
+import { LightboxService } from './implementations/lightboxService';
+export declare const definition: string & {
+    __api: import("./definition").ILightboxService;
+    __config: import("./definition").ILightboxServiceConfig;
+    isServiceDefinition?: boolean;
+} & import("./definition").ILightboxService;
+export default LightboxService;

package/cjs/build/service.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.definition = void 0;
+const definition_1 = require("./definition");
+const lightboxService_1 = require("./implementations/lightboxService");
+exports.definition = definition_1.LightboxDefinition;
+exports.default = lightboxService_1.LightboxService;
+//# sourceMappingURL=service.js.map

package/cjs/build/service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../../src/service.ts"],"names":[],"mappings":";;;AAAA,6CAAiD;AACjD,uEAAmE;AAEtD,QAAA,UAAU,GAAG,+BAAkB,CAAA;kBAC7B,iCAAe"}

package/cjs/build/types/index.d.ts

@@ -0,0 +1 @@
+export type { ILightboxService, ILightboxServiceConfig, ILightboxDefinition, LightboxContext, LightboxOpenOptions, } from '../definition';

package/cjs/build/types/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/cjs/build/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":""}

package/cjs/package.json

@@ -0,0 +1,3 @@
+{
+	"type": "commonjs"
+}

package/definition/package.json

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

package/dist/definition/index.d.ts

@@ -0,0 +1,23 @@
+import type { ServiceDefinition } from '@wix/services-definitions';
+export type LightboxContext = unknown;
+export type LightboxOpenOptions<TContext = LightboxContext> = {
+    pageId: string;
+    context?: TContext;
+};
+export type ILightboxServiceConfig = {
+    open: (options: LightboxOpenOptions) => Promise<void>;
+    close: () => void;
+    getContext: () => LightboxContext;
+};
+export interface ILightboxService {
+    open<TContext = LightboxContext>(options: LightboxOpenOptions<TContext>): Promise<void>;
+    close(): void;
+    /** Not checked against the context passed to `open`; the caller asserts its type. */
+    getContext<TContext = LightboxContext>(): TContext;
+}
+export type ILightboxDefinition = ServiceDefinition<ILightboxService, ILightboxServiceConfig>;
+export declare const LightboxDefinition: string & {
+    __api: ILightboxService;
+    __config: ILightboxServiceConfig;
+    isServiceDefinition?: boolean;
+} & ILightboxService;

package/dist/definition/index.js

@@ -0,0 +1,3 @@
+import { defineService } from '@wix/services-definitions';
+export const LightboxDefinition = defineService('@wix/site-service-lightbox');
+//# sourceMappingURL=index.js.map

package/dist/definition/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/definition/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAyBzD,MAAM,CAAC,MAAM,kBAAkB,GAAG,aAAa,CAA2C,4BAA4B,CAAC,CAAA"}

package/dist/implementations/index.d.ts

@@ -0,0 +1 @@
+export { LightboxService } from './lightboxService';

package/dist/implementations/index.js

@@ -0,0 +1,2 @@
+export { LightboxService } from './lightboxService';
+//# sourceMappingURL=index.js.map

package/dist/implementations/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/implementations/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA"}

package/dist/implementations/lightboxService.d.ts

@@ -0,0 +1,6 @@
+import type { ILightboxService, ILightboxServiceConfig } from '../definition';
+export declare const LightboxService: import("@wix/services-definitions").ServiceFactory<string & {
+    __api: ILightboxService;
+    __config: ILightboxServiceConfig;
+    isServiceDefinition?: boolean;
+} & ILightboxService, ILightboxServiceConfig>;

package/dist/implementations/lightboxService.js

@@ -0,0 +1,12 @@
+import { implementService } from '@wix/services-definitions';
+import { LightboxDefinition } from '../definition';
+export const LightboxService = implementService(LightboxDefinition, ({ config }) => {
+    return {
+        open: (options) => config.open(options),
+        close: () => {
+            config.close();
+        },
+        getContext: () => config.getContext(),
+    };
+});
+//# sourceMappingURL=lightboxService.js.map

package/dist/implementations/lightboxService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lightboxService.js","sourceRoot":"","sources":["../../src/implementations/lightboxService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AAG5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAElD,MAAM,CAAC,MAAM,eAAe,GAAG,gBAAgB,CAC9C,kBAAkB,EAClB,CAAC,EAAE,MAAM,EAA8C,EAAoB,EAAE;IAC5E,OAAO;QACN,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;QACvC,KAAK,EAAE,GAAG,EAAE;YACX,MAAM,CAAC,KAAK,EAAE,CAAA;QACf,CAAC;QACD,UAAU,EAAE,GAAa,EAAE,CAAC,MAAM,CAAC,UAAU,EAAc;KAC3D,CAAA;AACF,CAAC,CACD,CAAA"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './definition';
+export * from './implementations';

package/dist/index.js

@@ -0,0 +1,3 @@
+export * from './definition';
+export * from './implementations';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,mBAAmB,CAAA"}

package/dist/service.d.ts

@@ -0,0 +1,7 @@
+import { LightboxService } from './implementations/lightboxService';
+export declare const definition: string & {
+    __api: import("./definition").ILightboxService;
+    __config: import("./definition").ILightboxServiceConfig;
+    isServiceDefinition?: boolean;
+} & import("./definition").ILightboxService;
+export default LightboxService;

package/dist/service.js

@@ -0,0 +1,5 @@
+import { LightboxDefinition } from './definition';
+import { LightboxService } from './implementations/lightboxService';
+export const definition = LightboxDefinition;
+export default LightboxService;
+//# sourceMappingURL=service.js.map

package/dist/service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAA;AAEnE,MAAM,CAAC,MAAM,UAAU,GAAG,kBAAkB,CAAA;AAC5C,eAAe,eAAe,CAAA"}

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export type { ILightboxService, ILightboxServiceConfig, ILightboxDefinition, LightboxContext, LightboxOpenOptions, } from '../definition';

package/dist/types/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":""}

package/implementations/package.json

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

package/package.json

@@ -1,6 +1,81 @@
 {
   "name": "@wix/site-service-lightbox",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.0.0",
+  "license": "UNLICENSED",
+  "files": [
+    "dist",
+    "src",
+    "cjs",
+    "definition",
+    "implementations",
+    "types",
+    "!**/*.tsbuildinfo"
+  ],
+  "sideEffects": false,
+  "main": "cjs/build/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./cjs/build/index.js"
+    },
+    "./definition": {
+      "types": "./dist/definition/index.d.ts",
+      "import": "./dist/definition/index.js",
+      "require": "./cjs/build/definition/index.js"
+    },
+    "./implementations": {
+      "types": "./dist/implementations/index.d.ts",
+      "import": "./dist/implementations/index.js",
+      "require": "./cjs/build/implementations/index.js"
+    },
+    "./types": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/types/index.js",
+      "require": "./cjs/build/types/index.js"
+    },
+    "./service": {
+      "types": "./dist/service.d.ts",
+      "import": "./dist/service.js",
+      "require": "./cjs/build/service.js"
+    }
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -b  . --force && tsc --project tsconfig.cjs.json",
+    "lint": "yarn run -T lint:package $npm_package_name",
+    "test": "vitest --run && yarn test-type-check",
+    "test-type-check": "echo 'validating typescript in test files' && tsc --project tsconfig.test.json && echo 'Finished validating typescript in test files successfully'"
+  },
+  "dependencies": {
+    "@wix/services-definitions": "^0.1.4",
+    "@wix/services-manager": "^0.2.20"
+  },
+  "devDependencies": {
+    "typescript": "~7.0.2",
+    "vitest": "4.1.11"
+  },
+  "publishUnscoped": false,
+  "wix": {
+    "artifact": {
+      "groupId": "com.wixpress.npm",
+      "artifactId": "site-service-lightbox",
+      "targets": {
+        "static": false,
+        "docker": false
+      }
+    },
+    "validations": {
+      "postBuild": [
+        "test",
+        "lint"
+      ]
+    }
+  },
+  "falconPackageHash": "3aed728a64fa9c464fcfd8b4cc9c55256a46fe73218949841f21360f"
 }

package/src/definition/index.ts

@@ -0,0 +1,26 @@
+import { defineService } from '@wix/services-definitions'
+import type { ServiceDefinition } from '@wix/services-definitions'
+
+export type LightboxContext = unknown
+
+export type LightboxOpenOptions<TContext = LightboxContext> = {
+	pageId: string
+	context?: TContext
+}
+
+export type ILightboxServiceConfig = {
+	open: (options: LightboxOpenOptions) => Promise<void>
+	close: () => void
+	getContext: () => LightboxContext
+}
+
+export interface ILightboxService {
+	open<TContext = LightboxContext>(options: LightboxOpenOptions<TContext>): Promise<void>
+	close(): void
+	/** Not checked against the context passed to `open`; the caller asserts its type. */
+	getContext<TContext = LightboxContext>(): TContext
+}
+
+export type ILightboxDefinition = ServiceDefinition<ILightboxService, ILightboxServiceConfig>
+
+export const LightboxDefinition = defineService<ILightboxService, ILightboxServiceConfig>('@wix/site-service-lightbox')

package/src/implementations/index.ts

@@ -0,0 +1 @@
+export { LightboxService } from './lightboxService'

package/src/implementations/lightboxService.ts

@@ -0,0 +1,17 @@
+import { implementService } from '@wix/services-definitions'
+import type { ServiceFactoryOpts } from '@wix/services-definitions'
+import type { ILightboxService, ILightboxServiceConfig } from '../definition'
+import { LightboxDefinition } from '../definition'
+
+export const LightboxService = implementService(
+	LightboxDefinition,
+	({ config }: ServiceFactoryOpts<ILightboxServiceConfig>): ILightboxService => {
+		return {
+			open: (options) => config.open(options),
+			close: () => {
+				config.close()
+			},
+			getContext: <TContext>() => config.getContext() as TContext,
+		}
+	}
+)

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './definition'
+export * from './implementations'

package/src/service.ts

@@ -0,0 +1,5 @@
+import { LightboxDefinition } from './definition'
+import { LightboxService } from './implementations/lightboxService'
+
+export const definition = LightboxDefinition
+export default LightboxService

package/src/types/index.ts

@@ -0,0 +1,7 @@
+export type {
+	ILightboxService,
+	ILightboxServiceConfig,
+	ILightboxDefinition,
+	LightboxContext,
+	LightboxOpenOptions,
+} from '../definition'

package/types/package.json

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