@wix/site-service-pages 1.0.2 → 1.2.0

package/README.md

@@ -50,6 +50,10 @@ type PageConfig = {
     path: string
     parentPageId?: string
     popup: boolean
+    /** TPA page identifier (e.g. `ecom_side_cart`). Not globally unique on its own — pair with `appDefinitionId`. */
+    appPageId?: string
+    /** App definition ID of the TPA that owns this page. Use together with `appPageId` to identify a TPA popup. */
+    appDefinitionId?: string
 }
 
 type Page = PageConfig & { id: string }

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

@@ -1,16 +1,14 @@
 import type { ServiceDefinition } from '@wix/services-definitions';
-export type Page = {
-    id: string;
-    title: string;
-    path: string;
-    parentPageId?: string;
-    popup: boolean;
-};
 export type PageConfig = {
     title: string;
     path: string;
     parentPageId?: string;
     popup: boolean;
+    appPageId?: string;
+    appDefinitionId?: string;
+};
+export type Page = PageConfig & {
+    id: string;
 };
 export type IPagesServiceConfig = {
     /** id-as-key map; values omit `id` — callers use the key as the id (P3). */

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/definition/index.ts"],"names":[],"mappings":";;;AAAA,oEAAyD;AAoC5C,QAAA,eAAe,GAAG,IAAA,oCAAa,EAAqC,yBAAyB,CAAC,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/definition/index.ts"],"names":[],"mappings":";;;AAAA,oEAAyD;AAkC5C,QAAA,eAAe,GAAG,IAAA,oCAAa,EAAqC,yBAAyB,CAAC,CAAA"}

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

@@ -1 +1 @@
-{"version":3,"file":"pagesService.js","sourceRoot":"","sources":["../../../src/implementations/pagesService.ts"],"names":[],"mappings":";;;AAAA,oEAA4D;AAE5D,6EAA0F;AAE1F,8CAA+C;AAElC,QAAA,YAAY,GAAG,IAAA,uCAAgB,EACxC,4BAAe,EACf,CAAC,EAAE,MAAM,EAAE,UAAU,EAA2C,EAAiB,EAAE;IAC/E,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,kCAAwB,CAAC,CAAA;IACvD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IACnC,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;IACzC,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;IAE/C,OAAO;QACH,IAAI,KAAK;YACL,OAAO,MAAM,CAAC,GAAG,EAAE,CAAA;QACvB,CAAC;QACD,IAAI,QAAQ;YACR,OAAO,SAAS,CAAC,GAAG,EAAE,CAAA;QAC1B,CAAC;QACD,IAAI,WAAW;YACX,OAAO,YAAY,CAAC,GAAG,EAAE,CAAA;QAC7B,CAAC;QACD,aAAa,CAAC,aAAa;YACvB,IAAI,aAAa,CAAC,KAAK,EAAE,CAAC;gBACtB,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;YACnC,CAAC;YACD,IAAI,aAAa,CAAC,QAAQ,EAAE,CAAC;gBACzB,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAA;YACzC,CAAC;YACD,IAAI,aAAa,CAAC,WAAW,EAAE,CAAC;gBAC5B,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,CAAC,CAAA;YAC/C,CAAC;QACL,CAAC;KACJ,CAAA;AACL,CAAC,CACJ,CAAA"}
+{"version":3,"file":"pagesService.js","sourceRoot":"","sources":["../../../src/implementations/pagesService.ts"],"names":[],"mappings":";;;AAAA,oEAA4D;AAE5D,6EAA0F;AAE1F,8CAA+C;AAElC,QAAA,YAAY,GAAG,IAAA,uCAAgB,EAC3C,4BAAe,EACf,CAAC,EAAE,MAAM,EAAE,UAAU,EAA2C,EAAiB,EAAE;IAClF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,kCAAwB,CAAC,CAAA;IACvD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IACnC,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;IACzC,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;IAE/C,OAAO;QACN,IAAI,KAAK;YACR,OAAO,MAAM,CAAC,GAAG,EAAE,CAAA;QACpB,CAAC;QACD,IAAI,QAAQ;YACX,OAAO,SAAS,CAAC,GAAG,EAAE,CAAA;QACvB,CAAC;QACD,IAAI,WAAW;YACd,OAAO,YAAY,CAAC,GAAG,EAAE,CAAA;QAC1B,CAAC;QACD,aAAa,CAAC,aAAa;YAC1B,IAAI,aAAa,CAAC,KAAK,EAAE,CAAC;gBACzB,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;YAChC,CAAC;YACD,IAAI,aAAa,CAAC,QAAQ,EAAE,CAAC;gBAC5B,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAA;YACtC,CAAC;YACD,IAAI,aAAa,CAAC,WAAW,EAAE,CAAC;gBAC/B,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,CAAC,CAAA;YAC5C,CAAC;QACF,CAAC;KACD,CAAA;AACF,CAAC,CACD,CAAA"}

package/cjs/package.json

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

package/definition/package.json

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

package/dist/definition/index.d.ts

@@ -1,16 +1,14 @@
 import type { ServiceDefinition } from '@wix/services-definitions';
-export type Page = {
-    id: string;
-    title: string;
-    path: string;
-    parentPageId?: string;
-    popup: boolean;
-};
 export type PageConfig = {
     title: string;
     path: string;
     parentPageId?: string;
     popup: boolean;
+    appPageId?: string;
+    appDefinitionId?: string;
+};
+export type Page = PageConfig & {
+    id: string;
 };
 export type IPagesServiceConfig = {
     /** id-as-key map; values omit `id` — callers use the key as the id (P3). */

package/dist/definition/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/definition/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAoCzD,MAAM,CAAC,MAAM,eAAe,GAAG,aAAa,CAAqC,yBAAyB,CAAC,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/definition/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAkCzD,MAAM,CAAC,MAAM,eAAe,GAAG,aAAa,CAAqC,yBAAyB,CAAC,CAAA"}

package/dist/implementations/pagesService.js.map

@@ -1 +1 @@
-{"version":3,"file":"pagesService.js","sourceRoot":"","sources":["../../src/implementations/pagesService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AAE5D,OAAO,EAAE,wBAAwB,EAAE,MAAM,iDAAiD,CAAA;AAE1F,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAE/C,MAAM,CAAC,MAAM,YAAY,GAAG,gBAAgB,CACxC,eAAe,EACf,CAAC,EAAE,MAAM,EAAE,UAAU,EAA2C,EAAiB,EAAE;IAC/E,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,wBAAwB,CAAC,CAAA;IACvD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IACnC,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;IACzC,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;IAE/C,OAAO;QACH,IAAI,KAAK;YACL,OAAO,MAAM,CAAC,GAAG,EAAE,CAAA;QACvB,CAAC;QACD,IAAI,QAAQ;YACR,OAAO,SAAS,CAAC,GAAG,EAAE,CAAA;QAC1B,CAAC;QACD,IAAI,WAAW;YACX,OAAO,YAAY,CAAC,GAAG,EAAE,CAAA;QAC7B,CAAC;QACD,aAAa,CAAC,aAAa;YACvB,IAAI,aAAa,CAAC,KAAK,EAAE,CAAC;gBACtB,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;YACnC,CAAC;YACD,IAAI,aAAa,CAAC,QAAQ,EAAE,CAAC;gBACzB,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAA;YACzC,CAAC;YACD,IAAI,aAAa,CAAC,WAAW,EAAE,CAAC;gBAC5B,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,CAAC,CAAA;YAC/C,CAAC;QACL,CAAC;KACJ,CAAA;AACL,CAAC,CACJ,CAAA"}
+{"version":3,"file":"pagesService.js","sourceRoot":"","sources":["../../src/implementations/pagesService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AAE5D,OAAO,EAAE,wBAAwB,EAAE,MAAM,iDAAiD,CAAA;AAE1F,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAE/C,MAAM,CAAC,MAAM,YAAY,GAAG,gBAAgB,CAC3C,eAAe,EACf,CAAC,EAAE,MAAM,EAAE,UAAU,EAA2C,EAAiB,EAAE;IAClF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,wBAAwB,CAAC,CAAA;IACvD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IACnC,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;IACzC,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;IAE/C,OAAO;QACN,IAAI,KAAK;YACR,OAAO,MAAM,CAAC,GAAG,EAAE,CAAA;QACpB,CAAC;QACD,IAAI,QAAQ;YACX,OAAO,SAAS,CAAC,GAAG,EAAE,CAAA;QACvB,CAAC;QACD,IAAI,WAAW;YACd,OAAO,YAAY,CAAC,GAAG,EAAE,CAAA;QAC1B,CAAC;QACD,aAAa,CAAC,aAAa;YAC1B,IAAI,aAAa,CAAC,KAAK,EAAE,CAAC;gBACzB,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;YAChC,CAAC;YACD,IAAI,aAAa,CAAC,QAAQ,EAAE,CAAC;gBAC5B,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAA;YACtC,CAAC;YACD,IAAI,aAAa,CAAC,WAAW,EAAE,CAAC;gBAC/B,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,CAAC,CAAA;YAC5C,CAAC;QACF,CAAC;KACD,CAAA;AACF,CAAC,CACD,CAAA"}

package/implementations/package.json

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

package/package.json

@@ -1,9 +1,6 @@
 {
   "name": "@wix/site-service-pages",
-  "version": "1.0.2",
-  "main": "cjs/build/index.js",
-  "module": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "version": "1.2.0",
   "license": "UNLICENSED",
   "files": [
     "dist",
@@ -14,6 +11,10 @@
     "types",
     "!**/*.tsbuildinfo"
   ],
+  "sideEffects": false,
+  "main": "cjs/build/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -41,6 +42,16 @@
       "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"
@@ -49,18 +60,7 @@
     "typescript": "^5.3.3",
     "vitest": "4.1.0"
   },
-  "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'"
-  },
   "publishUnscoped": false,
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org/",
-    "access": "public"
-  },
-  "sideEffects": false,
   "wix": {
     "artifact": {
       "groupId": "com.wixpress.npm",
@@ -77,5 +77,5 @@
       ]
     }
   },
-  "falconPackageHash": "3ff54f019adc45b0bfc800cd99bbe11da3dd1be133207c04a6b6ddf5"
+  "falconPackageHash": "f440c70db95df7db4e68df837b2ca1ba88c64cf9dd2560df34fbd62e"
 }

package/src/definition/index.ts

@@ -1,35 +1,33 @@
 import { defineService } from '@wix/services-definitions'
 import type { ServiceDefinition } from '@wix/services-definitions'
 
-export type Page = {
-    id: string
-    title: string
-    path: string
-    parentPageId?: string
-    popup: boolean
+export type PageConfig = {
+	title: string
+	path: string
+	parentPageId?: string
+	popup: boolean
+	appPageId?: string
+	appDefinitionId?: string
 }
 
-export type PageConfig = {
-    title: string
-    path: string
-    parentPageId?: string
-    popup: boolean
+export type Page = PageConfig & {
+	id: string
 }
 
 export type IPagesServiceConfig = {
-    /** id-as-key map; values omit `id` — callers use the key as the id (P3). */
-    pages: { [pageId: string]: PageConfig }
-    /** Provider resolves and passes the full main page object; service stores it as-is. */
-    mainPage: Page
-    /** Provider resolves and passes the full current page object; service stores it as-is. */
-    currentPage: Page
+	/** id-as-key map; values omit `id` — callers use the key as the id (P3). */
+	pages: { [pageId: string]: PageConfig }
+	/** Provider resolves and passes the full main page object; service stores it as-is. */
+	mainPage: Page
+	/** Provider resolves and passes the full current page object; service stores it as-is. */
+	currentPage: Page
 }
 
 export interface IPagesService {
-    readonly pages: { [pageId: string]: PageConfig }
-    readonly mainPage: Page
-    readonly currentPage: Page
-    _updateConfig: (config: Partial<IPagesServiceConfig>) => void
+	readonly pages: { [pageId: string]: PageConfig }
+	readonly mainPage: Page
+	readonly currentPage: Page
+	_updateConfig: (config: Partial<IPagesServiceConfig>) => void
 }
 
 export type IPagesDefinition = ServiceDefinition<IPagesService, IPagesServiceConfig>

package/src/implementations/pagesService.ts

@@ -5,34 +5,34 @@ import type { IPagesService, IPagesServiceConfig } from '../definition'
 import { PagesDefinition } from '../definition'
 
 export const PagesService = implementService(
-    PagesDefinition,
-    ({ config, getService }: ServiceFactoryOpts<IPagesServiceConfig>): IPagesService => {
-        const { signal } = getService(SignalsServiceDefinition)
-        const _pages = signal(config.pages)
-        const _mainPage = signal(config.mainPage)
-        const _currentPage = signal(config.currentPage)
+	PagesDefinition,
+	({ config, getService }: ServiceFactoryOpts<IPagesServiceConfig>): IPagesService => {
+		const { signal } = getService(SignalsServiceDefinition)
+		const _pages = signal(config.pages)
+		const _mainPage = signal(config.mainPage)
+		const _currentPage = signal(config.currentPage)
 
-        return {
-            get pages() {
-                return _pages.get()
-            },
-            get mainPage() {
-                return _mainPage.get()
-            },
-            get currentPage() {
-                return _currentPage.get()
-            },
-            _updateConfig(partialConfig) {
-                if (partialConfig.pages) {
-                    _pages.set(partialConfig.pages)
-                }
-                if (partialConfig.mainPage) {
-                    _mainPage.set(partialConfig.mainPage)
-                }
-                if (partialConfig.currentPage) {
-                    _currentPage.set(partialConfig.currentPage)
-                }
-            },
-        }
-    }
+		return {
+			get pages() {
+				return _pages.get()
+			},
+			get mainPage() {
+				return _mainPage.get()
+			},
+			get currentPage() {
+				return _currentPage.get()
+			},
+			_updateConfig(partialConfig) {
+				if (partialConfig.pages) {
+					_pages.set(partialConfig.pages)
+				}
+				if (partialConfig.mainPage) {
+					_mainPage.set(partialConfig.mainPage)
+				}
+				if (partialConfig.currentPage) {
+					_currentPage.set(partialConfig.currentPage)
+				}
+			},
+		}
+	}
 )

package/types/package.json

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