@datapos/datapos-shared 0.3.300 → 0.3.303

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -4,16 +4,7 @@
4
4
  [![npm version](https://img.shields.io/npm/v/@datapos/datapos-shared.svg)](https://www.npmjs.com/package/@datapos/datapos-shared)
5
5
  [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE)
6
6
 
7
- A TypeScript library containing common declarations and utilities used across other Data Positioning repositories.
8
-
9
- ## Requirements
10
-
11
- Ensure your environment meets the following prerequisites before using this library:
12
-
13
- - **Node.js** version `>=22.0.0`,
14
- - **npm** version `>=11.0.0`,
15
- - A Unix-like shell (for command shortcuts, e.g., `bash`, `zsh`, or Git Bash on Windows),
16
- - Access to the [npm registry](https://www.npmjs.com/) and [GitHub](https://github.com/) for publishing and syncing.
7
+ A library containing common constants, types and utilities used across all Data Positioning projects.
17
8
 
18
9
  ## Installation
19
10
 
@@ -23,12 +14,7 @@ Install as a production dependency:
23
14
  npm install @datapos/datapos-shared
24
15
  ```
25
16
 
26
- Create `.npmrc` with access token. Access token needs to disable 2FA and allow all access.
27
-
28
- ```ini
29
- registry=https://registry.npmjs.org/
30
- //registry.npmjs.org/:_authToken=<ACCESS TOKEN>
31
- ```
17
+ > See the Data Positioning security documentation for additional initialization requirements.
32
18
 
33
19
  ## Declarations
34
20
 
@@ -112,15 +98,21 @@ let connectorConfig: ConnectorConfig;
112
98
  getComponentStatus('alpha');
113
99
  ```
114
100
 
115
- ## Reports & Compliance
101
+ Implements the common Data Positioning repository management command set. For more information see [@datapos/datapos-development](https://github.com/data-positioning/datapos-development).
116
102
 
117
- ### Dependency Check Report
103
+ ## Bundle Analysis Reports
104
+
105
+ The Bundle Analysis Report provides a detailed breakdown of the bundle's composition and module sizes, helping to identify which modules contribute most to the final build. It is generated automatically on each release using the npm package `rollup-plugin-visualizer`.
106
+
107
+ [View the Bundle Analysis Report](https://data-positioning.github.io/datapos-shared/stats.html)
108
+
109
+ ## Dependency Check Report
118
110
 
119
111
  The OWASP Dependency Check Report identifies known vulnerabilities in project dependencies. It is generated automatically on each release using the npm package [owasp-dependency-check](https://dependency-check.github.io/DependencyCheck/index.html). We also rely on GitHub Dependabot to continuously check for vulnerabilities across all dependencies.
120
112
 
121
113
  [View the OWASP Dependency Check Report](https://data-positioning.github.io/datapos-shared/dependency-check-report.html)
122
114
 
123
- ### Dependency Licenses
115
+ ## Dependency Licenses
124
116
 
125
117
  The following table lists top-level production and peer dependencies. All these dependencies (including transitive ones) have been recursively verified to use Apache-2.0, BSD-2-Clause, CC0-1.0, or MIT—commercially friendly licenses with minimal restrictions. Developers cloning this repository should independently verify dev and optional dependencies; users of the uploaded library are covered by these checks. We do not include unlicensed dependencies. Used to support development activity and not released as part of the production release. Check if you clone. We use the `npm` packages [license-report](https://www.npmjs.com/package/license-report), [license-report-check](https://www.npmjs.com/package/license-report-check) and [license-report-recursive](https://www.npmjs.com/package/license-report-recursive) to identify dependency licenses.
126
118
 
@@ -138,39 +130,6 @@ The following table lists top-level production and peer dependencies. All these
138
130
 
139
131
  **Installed dependencies are kept up-to-date with latest releases.**
140
132
 
141
- ### Bundle Analysis Report
142
-
143
- The Bundle Analysis Report provides a detailed breakdown of the bundle's composition and module sizes, helping to identify which modules contribute most to the final build. It is generated automatically on each release using the npm package `rollup-plugin-visualizer`.
144
-
145
- [View the Bundle Analysis Report](https://data-positioning.github.io/datapos-shared/stats.html)
146
-
147
- ## Repository Common Management Commands
148
-
149
- The table below lists the repository management commands available in this project.
150
- For detailed implementation, see the `scripts` section in the `package.json` file.
151
-
152
- | Name | Key Code | Notes |
153
- | ------------------ | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
154
- | audit | alt+ctrl+shift+a | Audit the project's dependencies for known security vulnerabilities. |
155
- | build | alt+ctrl+shift+b | Build the package using Vite. Output to '/dist' directory. |
156
- | bump:version | alt+ctrl+shift+v | Increment patch version number by 1. |
157
- | check | alt+ctrl+shift+c | Identify outdated dependencies using npm `outdated` and `npm-check-updates` with option to install latest versions. Also runs `retire` scanner. |
158
- | document | alt+ctrl+shift+d | Identify licenses of the project's production and peer dependencies. See [LICENSES.json](./LICENSES.json). |
159
- | format | alt+ctrl+shift+f | Use `prettier`to enforce formatting style rules. |
160
- | lint | alt+ctrl+shift+l | Use `eslint`to check the code for potential errors and enforces coding style rules. |
161
- | publish:toNPM | alt+ctrl+shift+p | Publish the package to npm. |
162
- | release | alt+ctrl+shift+r | Bump version, build library, synchronise with `GitHub` and publish to `npm`. |
163
- | send:deployNotice | alt+ctrl+shift+n | ❌ Not implemented. |
164
- | sync:withGitHub | alt+ctrl+shift+s | Synchronise local repository with the main GitHub repository. |
165
- | test | alt+ctrl+shift+t | ❌ Not implemented. |
166
- | update:dataPosDeps | alt+ctrl+shift+u | Install the latest version of all Data Positioning dependencies. |
167
-
168
- ## Compliance
169
-
170
- The following badge reflects FOSSA's assessment of this repository's open-source license compliance.
171
-
172
- [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fdata-positioning%2Fdatapos-shared.svg?type=large&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Fdata-positioning%2Fdatapos-shared?ref=badge_large&issueType=license)
173
-
174
133
  ## License
175
134
 
176
135
  [MIT](./LICENSE) © 2026 Data Positioning Pty Ltd
@@ -31,15 +31,15 @@ export interface Connector extends Component {
31
31
  upsertRecords?(connector: Connector, settings: UpsertSettings): Promise<void>;
32
32
  }
33
33
  export interface ConnectorConfig extends ModuleConfig {
34
- category?: ConnectorCategory;
34
+ category: ConnectorCategory | null;
35
35
  categoryId: ConnectorModuleCategoryId;
36
36
  implementations: Record<string, ConnectorImplementation>;
37
37
  operations: ConnectorOperation[];
38
38
  typeId: 'connector';
39
39
  usageId: ConnectorUsageId;
40
- vendorAccountURL?: string;
41
- vendorDocumentationURL?: string;
42
- vendorHomeURL?: string;
40
+ vendorAccountURL: string | null;
41
+ vendorDocumentationURL: string | null;
42
+ vendorHomeURL: string | null;
43
43
  }
44
44
  export type ConnectorLocalisedConfig = Omit<ConnectorConfig, 'label' | 'description'> & {
45
45
  label: string;
@@ -1,4 +1,3 @@
1
- import { Timestamp } from '../timestamp';
2
1
  import { LocaleCode, LocalisedString, StatusColorId } from '../index';
3
2
  export interface Component {
4
3
  readonly config: ComponentConfig;
@@ -7,11 +6,11 @@ export interface ComponentConfig {
7
6
  id: string;
8
7
  label: Partial<LocalisedString>;
9
8
  description: Partial<LocalisedString>;
10
- firstCreatedAt?: Timestamp;
11
- icon?: string;
12
- iconDark?: string;
13
- lastUpdatedAt?: Timestamp;
14
- status?: ComponentStatus;
9
+ firstCreatedAt?: number;
10
+ icon: string | null;
11
+ iconDark: string | null;
12
+ lastUpdatedAt: number | null;
13
+ status: ComponentStatus | null;
15
14
  statusId: ComponentStatusId;
16
15
  typeId: ComponentTypeId;
17
16
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@datapos/datapos-shared",
3
- "version": "0.3.300",
3
+ "version": "0.3.303",
4
4
  "description": "A library containing common constants, types and utilities used across all Data Positioning projects.",
5
5
  "license": "MIT",
6
6
  "author": "Jonathan Terrell <terrell.jm@gmail.com>",