@spscommerce/ds-shared 0.1.0

package/lib/sps-action.d.ts

@@ -0,0 +1,26 @@
+import type { MetadataProperty } from "@spscommerce/utils";
+/**
+ * Metadata describing an "action" that can be passed in
+ * to components such as modal and select.
+ */
+export interface SpsActionDescriptor {
+    label?: MetadataProperty<string>;
+    icon?: MetadataProperty<string>;
+    caption?: MetadataProperty<string>;
+    disabled?: MetadataProperty<boolean>;
+    isLink?: MetadataProperty<boolean>;
+    href?: MetadataProperty<string>;
+    newTab?: MetadataProperty<boolean>;
+}
+export declare const SPS_ACTION_DEFAULTS: SpsActionDescriptor;
+/** A method that has been decorated with `@SpsAction`. */
+export interface SpsActionMethod extends SpsActionDescriptor {
+    (...args: any[]): any;
+}
+/**
+ * Attaches metadata to the decorated method, designating it as an "action"
+ * that can be passed in to components such as modal and select. For example,
+ * if passed in to the modal, a button will be rendered in the modal using the
+ * specified label, icon, etc, and clicking that button will call the method.
+ */
+export declare function SpsAction(actionDescriptor: SpsActionDescriptor): MethodDecorator;

package/lib/stacked-horizontal-bar-chart.d.ts

@@ -0,0 +1,8 @@
+export declare enum StackedBarChartMilestone {
+    BLUE = "blue200",
+    GRAY = "gray600",
+    GREEN = "green200",
+    ORANGE = "orange200",
+    PURPLE = "purple200",
+    RED = "red200"
+}

package/lib/stepped-progress-bar.d.ts

@@ -0,0 +1,7 @@
+export declare enum SteppedProgressBarColor {
+    PURPLE = "purple",
+    RED = "red",
+    BLUE = "blue",
+    ORANGE = "orange",
+    GRAY = "gray"
+}

package/lib/table.d.ts

@@ -0,0 +1,12 @@
+export declare enum SortDirection {
+    ASCENDING = "ascending",
+    DESCENDING = "descending"
+}
+export interface SortedColumn {
+    key: string;
+    direction: SortDirection;
+}
+export declare type SortChangeHandler = (newSort: SortedColumn[]) => void;
+export declare type ResizeState = Record<string, number>;
+export declare type ResizeStateChangeHandler = (newResizeState: ResizeState) => void;
+export declare type SpsTableCellWrapWidth = 200 | 300 | 400 | 500 | 600;

package/lib/tabs.d.ts

@@ -0,0 +1,13 @@
+import type { SpsIcon } from "./icon";
+export interface SpsTab {
+    /** id of the tab itself. */
+    id?: string;
+    /**
+     * id of the pane associated with the tab, which is
+     * displayed when the tab is active.
+     */
+    controlsId?: string;
+    icon?: SpsIcon;
+    label: string;
+    tag?: string;
+}

package/lib/tag.d.ts

@@ -0,0 +1,9 @@
+export declare enum TagKind {
+    DEFAULT = "default",
+    KEY = "key",
+    WARNING = "warning",
+    ERROR = "error",
+    PENDING = "pending",
+    SUCCESS = "success",
+    INFO = "info"
+}

package/lib/task-queue.d.ts

@@ -0,0 +1,24 @@
+import { SpsIcon } from "./icon";
+import type { SpsActionMethod } from "./sps-action";
+/** The possible statuses for a task in the Task Queue. */
+export declare enum SpsTaskStatus {
+    COMPLETED = "completed",
+    ERRORED = "errored",
+    WARNING = "warning",
+    IN_PROGRESS = "in_progress"
+}
+export declare const SpsTaskStatusIcons: Readonly<{
+    completed: SpsIcon;
+    errored: SpsIcon;
+    warning: SpsIcon;
+    in_progress: string;
+}>;
+/** Represents a task in the Task Queue. */
+export interface SpsTask {
+    status: SpsTaskStatus;
+    unread: boolean;
+    heading: string;
+    subheading: any;
+    actions?: SpsActionMethod[];
+}
+export declare const TASK_QUEUE_NOTIFICATION_DURATION_MS = 5000;

package/lib/tooltip.d.ts

@@ -0,0 +1,13 @@
+export declare const TOOLTIP_HIDE_DELAY_MS_DEFAULT = 1000;
+export declare enum TooltipShowTrigger {
+    MANUAL = "manual",
+    MOUSEOVER = "mouseover",
+    CLICK = "click"
+}
+export declare enum TooltipKind {
+    DEFAULT = "default",
+    HELP = "help",
+    ERROR = "error",
+    WARNING = "warning",
+    CONTAINER = "container"
+}

package/lib/translations.d.ts

@@ -0,0 +1,139 @@
+declare const _default: {
+    advancedSearch: {
+        clear: string;
+        search: string;
+    };
+    button: {
+        spinningTitle: string;
+    };
+    columnChooser: {
+        removeButton: string;
+    };
+    contentRow: {
+        collapse: string;
+        expand: string;
+    };
+    datepicker: {
+        calendar: {
+            prevMonth: string;
+            nextMonth: string;
+        };
+        preset: {
+            custom: string;
+            today: string;
+            sevenDays: string;
+            thirtyDays: string;
+            sixtyDays: string;
+            ninetyDays: string;
+            oneYear: string;
+        };
+        presetsLabel: string;
+    };
+    fileUpload: {
+        acceptedTypes: string;
+        acceptedTypes_plural: string;
+        cancelled: string;
+        cancelled_plural: string;
+        close: string;
+        instructions: string;
+        instructions_plural: string;
+        maximumSize: string;
+        processing: string;
+        title: string;
+    };
+    filterPanel: {
+        clear: string;
+        title: string;
+        filterPlaceholder: string;
+    };
+    focusedTask: {
+        close: string;
+    };
+    growler: {
+        dismiss: string;
+    };
+    insightCard: {
+        all: string;
+        partnerCount: string;
+        partners: string;
+    };
+    insightTile: {
+        all: string;
+        partnerCount: string;
+        partners: string;
+    };
+    label: {
+        errors: {
+            dateConstraint: {
+                max: string;
+                min: string;
+            };
+            dateFormat: string;
+            dateRangeOrder: string;
+            dateValidity: string;
+            max: string;
+            maxLength: string;
+            min: string;
+            minLength: string;
+            required: string;
+        };
+        preventativeErrors: {
+            maxLength: string;
+            alpha: string;
+            numeric: string;
+            nonNumeric: string;
+        };
+        stronglySuggested: string;
+    };
+    listActionBar: {
+        clearSelected: string;
+        itemsSelected: string;
+    };
+    listToolbar: {
+        advancedSearchToggle: string;
+    };
+    modal: {
+        close: string;
+        defaultButtonLabel: string;
+        defaultTitle: {
+            general: string;
+            info: string;
+            success: string;
+            warning: string;
+            "serious-warning": string;
+        };
+    };
+    pagination: {
+        nextPage: string;
+        ofMany: string;
+        ofPageCount: string;
+        page: string;
+        prevPage: string;
+    };
+    progressBar: {
+        closeButtonTitle: string;
+    };
+    searchResultsBar: {
+        clear: string;
+        clearResults: string;
+        count: string;
+        matchingResults: string;
+        noAdvancedSearchSelections: string;
+        results: string;
+    };
+    select: {
+        defaultPlaceholder: string;
+    };
+    slackLink: {
+        label: string;
+    };
+    spinner: {
+        defaultAltText: string;
+    };
+    taskQueue: {
+        clearCompleted: string;
+        newTask: string;
+        noTasks: string;
+    };
+};
+export default _default;

package/lib/wizard-substep-condition.d.ts

@@ -0,0 +1,6 @@
+export declare enum WizardSubstepConditions {
+    BASIC = "basic",
+    COMPLETED = "completed",
+    COMPLETE = "completed",
+    ACTIVE = "active"
+}

package/lib/z-strata.d.ts

@@ -0,0 +1,7 @@
+export declare enum ZStratum {
+    BASE = 0,
+    TIP = 10,
+    DROPDOWN = 100,
+    BAR = 1000,
+    DIALOG = 10000
+}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@spscommerce/ds-shared",
+  "description": "Package for sharing code and types between DS Angular and DS React.",
+  "version": "0.1.0",
+  "author": "SPS Commerce",
+  "license": "UNLICENSED",
+  "repository": "https://github.com/spscommerce/design-system/tree/main/packages/@spscommerce/ds-shared",
+  "homepage": "https://github.com/spscommerce/design-system/tree/main/packages/@spscommerce/ds-shared#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "./lib/index.cjs.js",
+  "module": "./lib/index.es.js",
+  "types": "./lib/index.d.ts",
+  "peerDependencies": {
+    "@spscommerce/utils": "0.1.0",
+    "moment": "^2.25.3",
+    "moment-timezone": "^0.5.28"
+  },
+  "devDependencies": {
+    "@spscommerce/utils": "0.1.0",
+    "moment": "^2.25.3",
+    "moment-timezone": "^0.5.28"
+  },
+  "scripts": {
+    "build": "pnpm run build:copy-translations && pnpm run build:js && pnpm run build:types",
+    "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:copy-translations": "echo \"export default \"$(cat ../i18n/locales/en-US/design-system.json)\";\" > src/translations.ts"
+  },
+  "readme": "[//]: # \"START_AUTOGENERATED\"\n\n## [@spscommerce/ds-shared](https://github.com/spscommerce/design-system/tree/main/packages/@spscommerce/ds-shared#readme)\n\n![release: 1.1.0](https://img.shields.io/badge/release-1.1.0-blue.svg?style=flat-square)\n![build: passing](https://img.shields.io/badge/build-passing-green.svg?style=flat-square)\n![tests: failing](https://img.shields.io/badge/tests-failing-red.svg?style=flat-square)\n\nPackage for sharing code and types between DS Angular and DS React. \n \n ### Installation \n \n ```shell\nnpm install --save @spscommerce/ds-shared\n```\n\n#### Peer Dependencies\n\n<div class=\"row\">\n    <div class=\"col-5\"> \n    <table class=\"sps-table\">\n        <thead class=\"sps-table__head\">\n            <tr class=\"sps-table__row\">\n                <th class=\"sps-table__header\">\n                    <span class=\"sps-table__header-cell-body\">    \n                        Package\n                    </span>\n                </th>\n                <th class=\"sps-table__header text-right\">\n                    <span class=\"sps-table__header-cell-body\">    \n                        Version\n                    </span>\n                </th>\n            </tr>\n        </thead>\n        <tbody class=\"sps-table__body\">\n            <tr class=\"sps-table__row\"><td class=\"sps-table__cell\"><a href=\"https://github.com/spscommerce/design-system/tree/main/packages/@spscommerce/utils#readme\">@spscommerce/utils</a></td><td class=\"sps-table__cell text-right\">^1.1.0</td></tr>\n<tr class=\"sps-table__row\"><td class=\"sps-table__cell\"><a href=\"https://momentjs.com\">moment</a></td><td class=\"sps-table__cell text-right\">^2.25.3</td></tr>\n<tr class=\"sps-table__row\"><td class=\"sps-table__cell\"><a href=\"http://momentjs.com/timezone/\">moment-timezone</a></td><td class=\"sps-table__cell text-right\">^0.5.28</td></tr>\n        </tbody>\n    </table>\n    </div>\n    <div class=\"col-7\">\n        &nbsp;\n    </div>\n</div>\n\n[//]: # \"END_AUTOGENERATED\"\n"
+}

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+    "extends": "../../tsconfig.base.json",
+    "compilerOptions": {
+        "baseUrl": "tsconfig",
+        "rootDir": "src/",
+        "outDir": "./dist/out-tsc",
+        "target": "es5",
+        "esModuleInterop": true,
+        "declaration": true
+    },
+    "include": ["src/**/*"],
+    "exclude": ["node_modules", "lib"]
+}

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) : [],
+    },
+  },
+});