@wix/site-service-rendering-context 1.0.1

package/README.md

@@ -0,0 +1,45 @@
+# @wix/site-service-rendering-context
+
+Service exposing rendering-context flags (`SSR`, `SEO`) as a dedicated site-service.
+
+## Install
+
+```sh
+yarn add @wix/site-service-rendering-context
+```
+
+## Usage
+
+```ts
+import { RenderingContextDefinition } from '@wix/site-service-rendering-context/definition'
+import { RenderingContextService } from '@wix/site-service-rendering-context/implementations'
+
+createServicesMap().addService(RenderingContextDefinition, RenderingContextService, config)
+
+const service = servicesManager.getService(RenderingContextDefinition)
+// service.<property>  ← TS getter
+```
+
+## API
+
+| Member | Type | Throws when | Description |
+|---|---|---|---|
+| `SSR` | `boolean` | never | Whether current runtime is server-side rendering. |
+| `SEO` | `boolean` | never | Whether current rendering context is SEO mode. |
+
+## Configuration
+
+`IRenderingContextServiceConfig`:
+
+```ts
+type IRenderingContextServiceConfig = {
+    seo?: boolean
+}
+```
+
+`SSR` is not configurable — it is always derived at runtime from `globalThis.window === undefined`.
+When `seo` is not provided, it defaults to `false`.
+
+## Reactivity
+
+This service is read-only and not signal-backed. Values are resolved once at initialization.

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

@@ -0,0 +1,14 @@
+import type { ServiceDefinition } from '@wix/services-definitions';
+export type IRenderingContextServiceConfig = {
+    readonly seo?: boolean;
+};
+export interface IRenderingContextService {
+    readonly SSR: boolean;
+    readonly SEO: boolean;
+}
+export type IRenderingContextDefinition = ServiceDefinition<IRenderingContextService, IRenderingContextServiceConfig>;
+export declare const RenderingContextDefinition: string & {
+    __api: IRenderingContextService;
+    __config: IRenderingContextServiceConfig;
+    isServiceDefinition?: boolean;
+} & IRenderingContextService;

package/cjs/build/definition/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RenderingContextDefinition = void 0;
+const services_definitions_1 = require("@wix/services-definitions");
+exports.RenderingContextDefinition = (0, services_definitions_1.defineService)('@wix/site-service-rendering-context');
+//# 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;AAc5C,QAAA,0BAA0B,GAAG,IAAA,oCAAa,EACnD,qCAAqC,CACxC,CAAA"}

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

@@ -0,0 +1 @@
+export { RenderingContextService } from './renderingContextService';

package/cjs/build/implementations/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RenderingContextService = void 0;
+var renderingContextService_1 = require("./renderingContextService");
+Object.defineProperty(exports, "RenderingContextService", { enumerable: true, get: function () { return renderingContextService_1.RenderingContextService; } });
+//# 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,qEAAmE;AAA1D,kIAAA,uBAAuB,OAAA"}

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

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

package/cjs/build/implementations/renderingContextService.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RenderingContextService = void 0;
+const services_definitions_1 = require("@wix/services-definitions");
+const definition_1 = require("../definition");
+exports.RenderingContextService = (0, services_definitions_1.implementService)(definition_1.RenderingContextDefinition, ({ config }) => {
+    const SSR = globalThis.window === undefined;
+    const SEO = config.seo ?? false;
+    return {
+        get SSR() {
+            return SSR;
+        },
+        get SEO() {
+            return SEO;
+        },
+    };
+});
+//# sourceMappingURL=renderingContextService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"renderingContextService.js","sourceRoot":"","sources":["../../../src/implementations/renderingContextService.ts"],"names":[],"mappings":";;;AAAA,oEAA4D;AAG5D,8CAA0D;AAE7C,QAAA,uBAAuB,GAAG,IAAA,uCAAgB,EACnD,uCAA0B,EAC1B,CAAC,EAAE,MAAM,EAAsD,EAA4B,EAAE;IACzF,MAAM,GAAG,GAAG,UAAU,CAAC,MAAM,KAAK,SAAS,CAAA;IAC3C,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,IAAI,KAAK,CAAA;IAE/B,OAAO;QACH,IAAI,GAAG;YACH,OAAO,GAAG,CAAA;QACd,CAAC;QACD,IAAI,GAAG;YACH,OAAO,GAAG,CAAA;QACd,CAAC;KACJ,CAAA;AACL,CAAC,CACJ,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 { RenderingContextService } from './implementations/renderingContextService';
+export declare const definition: string & {
+    __api: import("./definition").IRenderingContextService;
+    __config: import("./definition").IRenderingContextServiceConfig;
+    isServiceDefinition?: boolean;
+} & import("./definition").IRenderingContextService;
+export default RenderingContextService;

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 renderingContextService_1 = require("./implementations/renderingContextService");
+exports.definition = definition_1.RenderingContextDefinition;
+exports.default = renderingContextService_1.RenderingContextService;
+//# 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,6CAAyD;AACzD,uFAAmF;AAEtE,QAAA,UAAU,GAAG,uCAA0B,CAAA;AACpD,kBAAe,iDAAuB,CAAA"}

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

@@ -0,0 +1 @@
+export type { IRenderingContextService, IRenderingContextServiceConfig, IRenderingContextDefinition, } 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,14 @@
+import type { ServiceDefinition } from '@wix/services-definitions';
+export type IRenderingContextServiceConfig = {
+    readonly seo?: boolean;
+};
+export interface IRenderingContextService {
+    readonly SSR: boolean;
+    readonly SEO: boolean;
+}
+export type IRenderingContextDefinition = ServiceDefinition<IRenderingContextService, IRenderingContextServiceConfig>;
+export declare const RenderingContextDefinition: string & {
+    __api: IRenderingContextService;
+    __config: IRenderingContextServiceConfig;
+    isServiceDefinition?: boolean;
+} & IRenderingContextService;

package/dist/definition/index.js

@@ -0,0 +1,3 @@
+import { defineService } from '@wix/services-definitions';
+export const RenderingContextDefinition = defineService('@wix/site-service-rendering-context');
+//# 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;AAczD,MAAM,CAAC,MAAM,0BAA0B,GAAG,aAAa,CACnD,qCAAqC,CACxC,CAAA"}

package/dist/implementations/index.d.ts

@@ -0,0 +1 @@
+export { RenderingContextService } from './renderingContextService';

package/dist/implementations/index.js

@@ -0,0 +1,2 @@
+export { RenderingContextService } from './renderingContextService';
+//# 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,uBAAuB,EAAE,MAAM,2BAA2B,CAAA"}

package/dist/implementations/renderingContextService.d.ts

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

package/dist/implementations/renderingContextService.js

@@ -0,0 +1,15 @@
+import { implementService } from '@wix/services-definitions';
+import { RenderingContextDefinition } from '../definition';
+export const RenderingContextService = implementService(RenderingContextDefinition, ({ config }) => {
+    const SSR = globalThis.window === undefined;
+    const SEO = config.seo ?? false;
+    return {
+        get SSR() {
+            return SSR;
+        },
+        get SEO() {
+            return SEO;
+        },
+    };
+});
+//# sourceMappingURL=renderingContextService.js.map

package/dist/implementations/renderingContextService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderingContextService.js","sourceRoot":"","sources":["../../src/implementations/renderingContextService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AAG5D,OAAO,EAAE,0BAA0B,EAAE,MAAM,eAAe,CAAA;AAE1D,MAAM,CAAC,MAAM,uBAAuB,GAAG,gBAAgB,CACnD,0BAA0B,EAC1B,CAAC,EAAE,MAAM,EAAsD,EAA4B,EAAE;IACzF,MAAM,GAAG,GAAG,UAAU,CAAC,MAAM,KAAK,SAAS,CAAA;IAC3C,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,IAAI,KAAK,CAAA;IAE/B,OAAO;QACH,IAAI,GAAG;YACH,OAAO,GAAG,CAAA;QACd,CAAC;QACD,IAAI,GAAG;YACH,OAAO,GAAG,CAAA;QACd,CAAC;KACJ,CAAA;AACL,CAAC,CACJ,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 { RenderingContextService } from './implementations/renderingContextService';
+export declare const definition: string & {
+    __api: import("./definition").IRenderingContextService;
+    __config: import("./definition").IRenderingContextServiceConfig;
+    isServiceDefinition?: boolean;
+} & import("./definition").IRenderingContextService;
+export default RenderingContextService;

package/dist/service.js

@@ -0,0 +1,5 @@
+import { RenderingContextDefinition } from './definition';
+import { RenderingContextService } from './implementations/renderingContextService';
+export const definition = RenderingContextDefinition;
+export default RenderingContextService;
+//# 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,0BAA0B,EAAE,MAAM,cAAc,CAAA;AACzD,OAAO,EAAE,uBAAuB,EAAE,MAAM,2CAA2C,CAAA;AAEnF,MAAM,CAAC,MAAM,UAAU,GAAG,0BAA0B,CAAA;AACpD,eAAe,uBAAuB,CAAA"}

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export type { IRenderingContextService, IRenderingContextServiceConfig, IRenderingContextDefinition, } 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

@@ -0,0 +1,81 @@
+{
+  "name": "@wix/site-service-rendering-context",
+  "version": "1.0.1",
+  "main": "cjs/build/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "license": "UNLICENSED",
+  "files": [
+    "dist",
+    "src",
+    "cjs",
+    "definition",
+    "implementations",
+    "types",
+    "!**/*.tsbuildinfo"
+  ],
+  "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"
+    }
+  },
+  "dependencies": {
+    "@wix/services-definitions": "^0.1.4",
+    "@wix/services-manager": "^0.2.20"
+  },
+  "devDependencies": {
+    "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",
+      "artifactId": "site-service-rendering-context",
+      "targets": {
+        "static": false,
+        "docker": false
+      }
+    },
+    "validations": {
+      "postBuild": [
+        "test",
+        "lint"
+      ]
+    }
+  },
+  "falconPackageHash": "64c62d1ad6336e747e51cc0abfe9da9b50ede0be14a4f13b30711bad"
+}

package/src/definition/index.ts

@@ -0,0 +1,17 @@
+import { defineService } from '@wix/services-definitions'
+import type { ServiceDefinition } from '@wix/services-definitions'
+
+export type IRenderingContextServiceConfig = {
+    readonly seo?: boolean
+}
+
+export interface IRenderingContextService {
+    readonly SSR: boolean
+    readonly SEO: boolean
+}
+
+export type IRenderingContextDefinition = ServiceDefinition<IRenderingContextService, IRenderingContextServiceConfig>
+
+export const RenderingContextDefinition = defineService<IRenderingContextService, IRenderingContextServiceConfig>(
+    '@wix/site-service-rendering-context'
+)

package/src/implementations/index.ts

@@ -0,0 +1 @@
+export { RenderingContextService } from './renderingContextService'

package/src/implementations/renderingContextService.ts

@@ -0,0 +1,21 @@
+import { implementService } from '@wix/services-definitions'
+import type { ServiceFactoryOpts } from '@wix/services-definitions'
+import type { IRenderingContextService, IRenderingContextServiceConfig } from '../definition'
+import { RenderingContextDefinition } from '../definition'
+
+export const RenderingContextService = implementService(
+    RenderingContextDefinition,
+    ({ config }: ServiceFactoryOpts<IRenderingContextServiceConfig>): IRenderingContextService => {
+        const SSR = globalThis.window === undefined
+        const SEO = config.seo ?? false
+
+        return {
+            get SSR() {
+                return SSR
+            },
+            get SEO() {
+                return SEO
+            },
+        }
+    }
+)

package/src/index.ts

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

package/src/service.ts

@@ -0,0 +1,5 @@
+import { RenderingContextDefinition } from './definition'
+import { RenderingContextService } from './implementations/renderingContextService'
+
+export const definition = RenderingContextDefinition
+export default RenderingContextService

package/src/types/index.ts

@@ -0,0 +1,5 @@
+export type {
+    IRenderingContextService,
+    IRenderingContextServiceConfig,
+    IRenderingContextDefinition,
+} from '../definition'

package/types/package.json

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