@retailcrm/embed-ui 0.0.1

package/.github/workflows/tests.yml

@@ -0,0 +1,39 @@
+name: Tests
+
+on: [push, pull_request]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  eslint:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [ 18.18.x, 20.x ]
+
+    steps:
+      - name: Using branch ${{ github.ref }} for repository ${{ github.repository }}.
+        uses: actions/checkout@v4
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Cache dependencies
+        id: cache-deps
+        uses: actions/cache@v4
+        with:
+          path: .yarn
+          key: ${{ runner.OS }}-node-${{ matrix.node-version }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.OS }}-node-${{ matrix.node-version }}-yarn-
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Run lint
+        run: yarn lint

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+### 0.0.1 (2024-04-26)
+
+
+### Features
+
+* Added basic types ([6bb2706](https://github.com/retailcrm/embed-ui/commit/6bb27060b3a9eca281865029e1688e44117f03f7))

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 RetailCRM
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,2 @@
+# embed-ui
+API и компоненты для создания расширений интерфейса RetailCRM

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@retailcrm/embed-ui",
+  "type": "module",
+  "version": "0.0.1",
+  "description": "API and components for creating RetailCRM UI extensions",
+  "main": "index.js",
+  "repository": "git@github.com:retailcrm/embed-ui.git",
+  "author": "RetailDriverLLC <integration@retailcrm.ru>",
+  "license": "MIT",
+  "contributors": [
+    "Kirill Zaytsev <zaytsev.cmath10@gmail.com>"
+  ],
+  "scripts": {
+    "lint": "eslint .",
+    "release": "standard-version",
+    "release:major": "standard-version --release-as major",
+    "release:minor": "standard-version --release-as minor",
+    "release:patch": "standard-version --release-as patch"
+  },
+  "dependencies": {
+    "@remote-ui/core": "^2.2.4",
+    "@remote-ui/rpc": "^1.4.5"
+  },
+  "devDependencies": {
+    "@eslint/eslintrc": "^3.0.2",
+    "@eslint/js": "^9.1.1",
+    "@stylistic/eslint-plugin": "^1.7.2",
+    "eslint": "^9.1.1",
+    "eslint-config-standard-with-typescript": "^43.0.1",
+    "eslint-plugin-import": "^2.25.2",
+    "eslint-plugin-n": "^17.3.1",
+    "eslint-plugin-promise": "^6.1.1",
+    "globals": "^15.0.0",
+    "standard-version": "^9.5.0",
+    "typescript": "^5.4.5",
+    "typescript-eslint": "^7.7.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/types/endpoint.d.ts

@@ -0,0 +1,18 @@
+import type {
+  AnyFunction,
+  None,
+} from './scaffolding'
+
+import type { RemoteChannel } from '@remote-ui/core'
+import type { Endpoint as RemoteEndpoint } from '@remote-ui/rpc'
+
+export interface EndpointApi<
+  PageApi extends Record<string, AnyFunction> = None
+> {
+  run (channel: RemoteChannel, api: PageApi): Promise<void>;
+  release (): void;
+}
+
+export type Endpoint<
+  PageApi extends Record<string, AnyFunction> = None
+> = RemoteEndpoint<EndpointApi<PageApi>>

package/types/pages/order.d.ts

@@ -0,0 +1,11 @@
+export type OrderCardMethods = {
+  getCustomerEmail: () => string | null,
+  setCustomerEmail: (value: string) => void,
+
+  getCustomerPhone: () => string | null,
+  setCustomerPhone: (value: string) => void,
+
+  getDeliveryAddress: () => string | null,
+  setDeliveryAddress: (value: string) => void,
+  parseDeliveryAddress: () => void,
+}

package/types/scaffolding.d.ts

@@ -0,0 +1,2 @@
+export type AnyFunction = (...payload: any[]) => unknown
+export type None = Record<string, never>