@datapos/datapos-development 0.3.63 → 0.3.65

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.
Files changed (4) hide show
  1. package/README.md +27 -22
  2. package/dist/datapos-development.es.js +2159 -126
  3. package/dist/types/src/index.d.ts +2 -2
  4. package/package.json +27 -8
package/README.md CHANGED
@@ -36,17 +36,17 @@ The `src/index.ts' file exposes the following utilities:
36
36
  | Name | Notes |
37
37
  | ------------------------- | ------------------------------------------------------------------------ |
38
38
  | buildConfig | Build the config.json file for the repository. |
39
- | buildConnectorConfig | |
40
- | buildContextConfig | |
41
- | buildInformerConfig | |
42
- | buildPresenterConfig | |
39
+ | buildConnectorConfig | Build the connector config.json file for the repository. |
40
+ | buildContextConfig | Build the context config.json file for the repository. |
41
+ | buildInformerConfig | Build the informer config.json file for the repository. |
42
+ | buildPresenterConfig | Build the presenter config.json file for the repository. |
43
43
  | buildPublicDirectoryIndex | Build an index for the repositories public directory. |
44
44
  | bumpVersion | Bump the repositories version number. |
45
- | clearDirectory | Clear the specified directory. |
45
+ | echoScriptNotImplemented | Echo script not implemented message to console.. |
46
46
  | sendDeploymentNotice | Send a deployment notice for the repository. |
47
47
  | syncWithGitHub | Synchronise the local repository with the main GitHub repository. |
48
48
  | uploadDirectoryToR2 | Upload a directory to Cloudflare R2 storage. |
49
- | uploadModuleConfig | Upload a modules configuration to the Cloudflare `state` durable object. |
49
+ | uploadModuleConfigToDO | Upload a modules configuration to the Cloudflare `state` durable object. |
50
50
  | uploadModuleToR2 | Upload a module to Cloudflare R2 storage. |
51
51
 
52
52
  ## Repository Common Management Commands
@@ -54,22 +54,27 @@ The `src/index.ts' file exposes the following utilities:
54
54
  The table below lists the repository management commands available in this project.
55
55
  For detailed implementation, see the `scripts` section in the `package.json` file.
56
56
 
57
- | Name | Key Code | Notes |
58
- | -------------------- | ---------------- | ---------------------------------------------------------------------------------------------------------- |
59
- | audit | alt+ctrl+shift+a | Audit the project's dependencies for known security vulnerabilities. |
60
- | build | alt+ctrl+shift+b | Build the package using Vite. |
61
- | build...Config | | ❌ Not implemented. |
62
- | bumpVersion | alt+ctrl+shift+v | |
63
- | check | alt+ctrl+shift+c | List outdated dependencies and run retire scanner. |
64
- | document | alt+ctrl+shift+d | Identify licenses of the project's production and peer dependencies. See [LICENSES.json](./LICENSES.json). |
65
- | format | alt+ctrl+shift+f | Enforce formatting style rules. |
66
- | lint | alt+ctrl+shift+l | Check the code for errors and enforce coding style rules. |
67
- | publishToNPM | alt+ctrl+shift+p | |
68
- | release | alt+ctrl+shift+r | Bump version, synchronise local repository with the main GitHub repository and publish to npm. |
69
- | sendDeploymentNotice | | ❌ Not implemented. |
70
- | syncWithGitHub | alt+ctrl+shift+s | Bump version and synchronise local repository with the main GitHub repository. |
71
- | test | alt+ctrl+shift+t | ❌ Not implemented. |
72
- | updateDependencies | alt+ctrl+shift+u | ❌ Not implemented. |
57
+ | Name | Key Code | Notes |
58
+ | ------------------ | ---------------- | ---------------------------------------------------------------------------------------------------------- |
59
+ | audit | alt+ctrl+shift+a | Audit the project's dependencies for known security vulnerabilities. |
60
+ | build | alt+ctrl+shift+b | Build the package using Vite. |
61
+ | bump:version | alt+ctrl+shift+v | Increment patch version number. |
62
+ | check | alt+ctrl+shift+c | List outdated dependencies and run retire scanner. |
63
+ | document | alt+ctrl+shift+d | Identify licenses of the project's production and peer dependencies. See [LICENSES.json](./LICENSES.json). |
64
+ | format | alt+ctrl+shift+f | Enforce formatting style rules. |
65
+ | lint | alt+ctrl+shift+l | Check the code for errors and enforce coding style rules. |
66
+ | publish:toNPM | alt+ctrl+shift+p | Publish the package to npm. |
67
+ | release | alt+ctrl+shift+r | Bump version, synchronise local repository with the main GitHub repository and publish to npm. |
68
+ | send:deployNotice | alt+ctrl+shift+n | ❌ Not implemented. |
69
+ | sync:withGitHub | alt+ctrl+shift+s | Bump version and synchronise local repository with the main GitHub repository. |
70
+ | test | alt+ctrl+shift+t | ❌ Not implemented. |
71
+ | update:dataPosDeps | alt+ctrl+shift+u | Install the latest version of all Data Positioning dependencies. |
72
+
73
+ ## TODO
74
+
75
+ 1. Enhance `uploadDirectoryToR2`to batch upload files so more efficient and performant.
76
+ 1. Replace regex with TypeScript AST in `buildConnectorConfig`. More accurate.
77
+ 1. Implement zod to validate config schemas.
73
78
 
74
79
  ## Compliance
75
80