@spscommerce/ds-web-components 0.1.0

package/lib/manifest.d.ts

@@ -0,0 +1,2 @@
+import type { ComponentManifest } from "@spscommerce/ds-shared";
+export declare const MANIFEST: ComponentManifest;

package/lib/utils/comment.d.ts

@@ -0,0 +1,2 @@
+/** docs:ignore */
+export declare function comment(content: string): any;

package/lib/utils/i18n.d.ts

@@ -0,0 +1,3 @@
+import type { I18nObject } from "@spscommerce/ds-shared";
+export declare function webComponentsUseI18n(i18n: I18nObject): void;
+export declare function getI18n(): I18nObject;

package/lib/utils/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./comment";
+export * from "./i18n";
+export * from "./metadata";
+export * from "./pragma";
+export * from "./register";

package/lib/utils/metadata.d.ts

@@ -0,0 +1,22 @@
+export interface ComponentConfig {
+    tag: string;
+}
+/** docs:ignore */
+export interface ComponentChildQuery {
+    key: string;
+    selector: string;
+    refresh: boolean;
+    all: boolean;
+}
+/** docs:ignore */
+export interface ComponentMetadata extends ComponentConfig {
+    childQueries?: ComponentChildQuery[];
+    contentProp?: PropertyKey;
+    eventListeners?: Array<[string, PropertyKey]>;
+}
+/** docs:ignore */
+export declare const Metadata: Readonly<{
+    has(target: any, key: string): boolean;
+    add(target: any, metadata: Partial<ComponentMetadata>): void;
+    get<T = any>(target: any, key: string, defaultValue?: T): T;
+}>;

package/lib/utils/pragma.d.ts

@@ -0,0 +1,6 @@
+/** docs:ignore */
+export declare const MARK_CONTENT_START = "idom-pragma:content-begin";
+/** docs:ignore */
+export declare const MARK_CONTENT_END = "idom-pragma:content-end";
+/** JSX pragma that utilizes incremental-dom. */
+export declare function h(tagName: string, attrs: any, ...children: any[]): () => void;

package/lib/utils/register.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Register a list of DS web components so that they can be used. Should be done
+ * just once in your app, at init/bootstrap time.
+ */
+export declare function register(...Components: any[]): void;
+/**
+ * If for some reason you have a tag name conflict between a DS web component and
+ * another component in your app, you can use this to override the "sps" namespace
+ * for the DS web component(s). You pass in the new namespace, and it returns a customized
+ * `register()` function that you can pass DS web components to. For example, you could
+ * use this to make `<sps-photo>` become `<foo-photo>` instead.
+ */
+export declare function namespaceOverrideRegistrar(overrideNamespace: string): (...Components: any[]) => void;

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@spscommerce/ds-web-components",
+  "description": "SPS Design System Native Web Components",
+  "version": "0.1.0",
+  "author": "SPS Commerce",
+  "license": "UNLICENSED",
+  "repository": "https://github.com/spscommerce/design-system/tree/main/packages/@spscommerce/ds-web-components",
+  "homepage": "https://github.com/spscommerce/design-system/tree/main/packages/@spscommerce/ds-web-components#readme",
+  "main": "./lib/index.cjs.js",
+  "module": "./lib/index.es.js",
+  "types": "./lib/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "incremental-dom": "^0.6.0"
+  },
+  "peerDependencies": {
+    "@spscommerce/ds-shared": "0.1.0",
+    "@spscommerce/utils": "0.1.0"
+  },
+  "devDependencies": {
+    "@spscommerce/ds-shared": "0.1.0",
+    "@spscommerce/utils": "0.1.0"
+  },
+  "scripts": {
+    "build": "pnpm run build:js && pnpm run build:types && pnpm run build:create-dist && pnpm run build:copy-dist",
+    "build:js": "vite build",
+    "build:types": "tsc --emitDeclarationOnly --declaration --declarationDir lib",
+    "watch": "vite build --watch",
+    "clean": "git clean -fdX",
+    "pub": "pnpm pack && node ../../scripts/publish-package.js",
+    "build:create-dist": "mkdir -p dist && cp -r lib dist/ && cp package.json dist/ && cp README.md dist/ && cp global.d.ts dist/",
+    "build:copy-dist": "node ../../scripts/copy-built-package.js ../../node_modules/@spscommerce/ds-web-components"
+  },
+  "readme": "[//]: # \"START_AUTOGENERATED\"\n\n[//]: # \"END_AUTOGENERATED\"\n"
+}

package/vite.config.js

@@ -0,0 +1,20 @@
+import path from 'path';
+
+import { defineConfig } from 'vite';
+
+import pkg from './package.json';
+
+export default defineConfig({
+  build: {
+    lib: {
+      entry: path.resolve(__dirname, 'src/index.ts'),
+      formats: ['es', 'cjs'],
+      fileName: (format) => `index.${format}.js`,
+    },
+    outDir: path.resolve(__dirname, './lib'),
+    emptyOutDir: false,
+    rollupOptions: {
+      external: pkg.peerDependencies ? Object.keys(pkg.peerDependencies) : [],
+    },
+  },
+});