@xemahq/xema-shell-api-client 0.1.0 → 0.2.0

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 (71) hide show
  1. package/LICENSE +174 -201
  2. package/README.md +62 -0
  3. package/dist/custom-fetch.d.ts +1 -1
  4. package/dist/custom-fetch.js +1 -1
  5. package/dist/endpoints/shell/shell.d.ts +18 -6
  6. package/dist/endpoints/shell/shell.js +39 -9
  7. package/dist/endpoints/xvfs/xvfs.d.ts +6 -6
  8. package/dist/endpoints/xvfs/xvfs.js +8 -8
  9. package/dist/models/index.d.ts +11 -1
  10. package/dist/models/index.js +11 -1
  11. package/dist/models/shellCommandDescriptorDto.d.ts +28 -0
  12. package/dist/models/shellCommandDescriptorDto.js +2 -0
  13. package/dist/models/shellCommandDescriptorDtoOutputSchema.d.ts +13 -0
  14. package/dist/models/{shellRunResponseDtoData.js → shellCommandDescriptorDtoOutputSchema.js} +1 -1
  15. package/dist/models/shellHelpCommandResponseDto.d.ts +12 -0
  16. package/dist/models/shellHelpCommandResponseDto.js +2 -0
  17. package/dist/models/shellHelpCommandResponseDtoDataEnvelope.d.ts +11 -0
  18. package/dist/models/shellHelpCommandResponseDtoDataEnvelope.js +2 -0
  19. package/dist/models/shellHelpListResponseDto.d.ts +12 -0
  20. package/dist/models/shellHelpListResponseDto.js +2 -0
  21. package/dist/models/shellHelpListResponseDtoDataEnvelope.d.ts +11 -0
  22. package/dist/models/shellHelpListResponseDtoDataEnvelope.js +2 -0
  23. package/dist/models/shellParseResponseDto.d.ts +2 -2
  24. package/dist/models/shellParseResponseDtoDataEnvelope.d.ts +11 -0
  25. package/dist/models/shellParseResponseDtoDataEnvelope.js +2 -0
  26. package/dist/models/shellParseResponseDtoOptions.d.ts +1 -1
  27. package/dist/models/shellParseResponseDtoOptions.js +1 -1
  28. package/dist/models/shellRunDenialDto.d.ts +3 -3
  29. package/dist/models/shellRunDenialDtoSuggestionsItem.d.ts +1 -1
  30. package/dist/models/shellRunDenialDtoSuggestionsItem.js +1 -1
  31. package/dist/models/shellRunDenialReasonDto.d.ts +1 -1
  32. package/dist/models/shellRunDenialReasonDto.js +1 -1
  33. package/dist/models/shellRunDiagnosticDto.d.ts +2 -2
  34. package/dist/models/shellRunDiagnosticDtoLevel.d.ts +1 -1
  35. package/dist/models/shellRunDiagnosticDtoLevel.js +1 -1
  36. package/dist/models/shellRunRequestDto.d.ts +3 -3
  37. package/dist/models/shellRunRequestDtoOutputMode.d.ts +1 -1
  38. package/dist/models/shellRunRequestDtoOutputMode.js +1 -1
  39. package/dist/models/shellRunRequestDtoStdin.d.ts +1 -1
  40. package/dist/models/shellRunRequestDtoStdin.js +1 -1
  41. package/dist/models/shellRunResponseDto.d.ts +6 -6
  42. package/dist/models/shellRunResponseDtoDataEnvelope.d.ts +11 -0
  43. package/dist/models/shellRunResponseDtoDataEnvelope.js +2 -0
  44. package/dist/models/{shellRunResponseDtoData.d.ts → shellRunResponseDtoResult.d.ts} +2 -2
  45. package/dist/models/shellRunResponseDtoResult.js +9 -0
  46. package/dist/models/shellRunResponseDtoStatus.d.ts +1 -1
  47. package/dist/models/shellRunResponseDtoStatus.js +1 -1
  48. package/dist/models/spaceKind.d.ts +2 -2
  49. package/dist/models/spaceKind.js +1 -1
  50. package/dist/models/spaceRefDto.d.ts +2 -2
  51. package/dist/models/xemaObjectKind.d.ts +2 -3
  52. package/dist/models/xemaObjectKind.js +1 -2
  53. package/dist/models/xvfsControllerResolveParams.d.ts +1 -1
  54. package/dist/models/xvfsControllerResolveParams.js +1 -1
  55. package/dist/models/xvfsControllerWriteParams.d.ts +1 -1
  56. package/dist/models/xvfsControllerWriteParams.js +1 -1
  57. package/dist/models/xvfsResolvedDto.d.ts +4 -4
  58. package/dist/models/xvfsResolvedDtoDataEnvelope.d.ts +11 -0
  59. package/dist/models/xvfsResolvedDtoDataEnvelope.js +2 -0
  60. package/dist/models/xvfsResolvedDtoPayload.d.ts +1 -1
  61. package/dist/models/xvfsResolvedDtoPayload.js +1 -1
  62. package/dist/models/xvfsWriteBodyDto.d.ts +2 -2
  63. package/dist/models/xvfsWriteBodyDtoPayload.d.ts +1 -1
  64. package/dist/models/xvfsWriteBodyDtoPayload.js +1 -1
  65. package/dist/models/xvfsWriteResultDto.d.ts +1 -1
  66. package/dist/models/xvfsWriteResultDto.js +1 -1
  67. package/dist/models/xvfsWriteResultDtoDataEnvelope.d.ts +11 -0
  68. package/dist/models/xvfsWriteResultDtoDataEnvelope.js +2 -0
  69. package/package.json +14 -3
  70. package/dist/endpoints/health/health.d.ts +0 -15
  71. package/dist/endpoints/health/health.js +0 -53
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  /**
3
- * Generated by orval v8.6.2 🍺
3
+ * Generated by orval v8.16.0 🍺
4
4
  * Do not edit manually.
5
5
  * Xema Shell API
6
6
  * Xema Shell + XVFS. Phase 2 ships the read-only XVFS resolve endpoint; full Shell commands + websocket + write path land in Phase 5.
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Generated by orval v8.6.2 🍺
2
+ * Generated by orval v8.16.0 🍺
3
3
  * Do not edit manually.
4
4
  * Xema Shell API
5
5
  * Xema Shell + XVFS. Phase 2 ships the read-only XVFS resolve endpoint; full Shell commands + websocket + write path land in Phase 5.
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  /**
3
- * Generated by orval v8.6.2 🍺
3
+ * Generated by orval v8.16.0 🍺
4
4
  * Do not edit manually.
5
5
  * Xema Shell API
6
6
  * Xema Shell + XVFS. Phase 2 ships the read-only XVFS resolve endpoint; full Shell commands + websocket + write path land in Phase 5.
@@ -1,13 +1,13 @@
1
1
  /**
2
- * Generated by orval v8.6.2 🍺
2
+ * Generated by orval v8.16.0 🍺
3
3
  * Do not edit manually.
4
4
  * Xema Shell API
5
5
  * Xema Shell + XVFS. Phase 2 ships the read-only XVFS resolve endpoint; full Shell commands + websocket + write path land in Phase 5.
6
6
  * OpenAPI spec version: 0.1.0
7
7
  */
8
- import type { SpaceRefDto } from './spaceRefDto';
9
- import type { XemaObjectKind } from './xemaObjectKind';
10
- import type { XvfsResolvedDtoPayload } from './xvfsResolvedDtoPayload';
8
+ import type { SpaceRefDto } from './spaceRefDto.js';
9
+ import type { XemaObjectKind } from './xemaObjectKind.js';
10
+ import type { XvfsResolvedDtoPayload } from './xvfsResolvedDtoPayload.js';
11
11
  export interface XvfsResolvedDto {
12
12
  /** Closed-set object kind. */
13
13
  kind: XemaObjectKind;
@@ -0,0 +1,11 @@
1
+ /**
2
+ * Generated by orval v8.16.0 🍺
3
+ * Do not edit manually.
4
+ * Xema Shell API
5
+ * Xema Shell + XVFS. Phase 2 ships the read-only XVFS resolve endpoint; full Shell commands + websocket + write path land in Phase 5.
6
+ * OpenAPI spec version: 0.1.0
7
+ */
8
+ import type { XvfsResolvedDto } from './xvfsResolvedDto.js';
9
+ export interface XvfsResolvedDtoDataEnvelope {
10
+ data: XvfsResolvedDto;
11
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Generated by orval v8.6.2 🍺
2
+ * Generated by orval v8.16.0 🍺
3
3
  * Do not edit manually.
4
4
  * Xema Shell API
5
5
  * Xema Shell + XVFS. Phase 2 ships the read-only XVFS resolve endpoint; full Shell commands + websocket + write path land in Phase 5.
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  /**
3
- * Generated by orval v8.6.2 🍺
3
+ * Generated by orval v8.16.0 🍺
4
4
  * Do not edit manually.
5
5
  * Xema Shell API
6
6
  * Xema Shell + XVFS. Phase 2 ships the read-only XVFS resolve endpoint; full Shell commands + websocket + write path land in Phase 5.
@@ -1,11 +1,11 @@
1
1
  /**
2
- * Generated by orval v8.6.2 🍺
2
+ * Generated by orval v8.16.0 🍺
3
3
  * Do not edit manually.
4
4
  * Xema Shell API
5
5
  * Xema Shell + XVFS. Phase 2 ships the read-only XVFS resolve endpoint; full Shell commands + websocket + write path land in Phase 5.
6
6
  * OpenAPI spec version: 0.1.0
7
7
  */
8
- import type { XvfsWriteBodyDtoPayload } from './xvfsWriteBodyDtoPayload';
8
+ import type { XvfsWriteBodyDtoPayload } from './xvfsWriteBodyDtoPayload.js';
9
9
  export interface XvfsWriteBodyDto {
10
10
  /** Kind-specific payload to write/upsert at the resolved object ref. Schema is owned by the object-registry-api for the resolved XemaObjectKind. */
11
11
  payload: XvfsWriteBodyDtoPayload;
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Generated by orval v8.6.2 🍺
2
+ * Generated by orval v8.16.0 🍺
3
3
  * Do not edit manually.
4
4
  * Xema Shell API
5
5
  * Xema Shell + XVFS. Phase 2 ships the read-only XVFS resolve endpoint; full Shell commands + websocket + write path land in Phase 5.
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  /**
3
- * Generated by orval v8.6.2 🍺
3
+ * Generated by orval v8.16.0 🍺
4
4
  * Do not edit manually.
5
5
  * Xema Shell API
6
6
  * Xema Shell + XVFS. Phase 2 ships the read-only XVFS resolve endpoint; full Shell commands + websocket + write path land in Phase 5.
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Generated by orval v8.6.2 🍺
2
+ * Generated by orval v8.16.0 🍺
3
3
  * Do not edit manually.
4
4
  * Xema Shell API
5
5
  * Xema Shell + XVFS. Phase 2 ships the read-only XVFS resolve endpoint; full Shell commands + websocket + write path land in Phase 5.
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  /**
3
- * Generated by orval v8.6.2 🍺
3
+ * Generated by orval v8.16.0 🍺
4
4
  * Do not edit manually.
5
5
  * Xema Shell API
6
6
  * Xema Shell + XVFS. Phase 2 ships the read-only XVFS resolve endpoint; full Shell commands + websocket + write path land in Phase 5.
@@ -0,0 +1,11 @@
1
+ /**
2
+ * Generated by orval v8.16.0 🍺
3
+ * Do not edit manually.
4
+ * Xema Shell API
5
+ * Xema Shell + XVFS. Phase 2 ships the read-only XVFS resolve endpoint; full Shell commands + websocket + write path land in Phase 5.
6
+ * OpenAPI spec version: 0.1.0
7
+ */
8
+ import type { XvfsWriteResultDto } from './xvfsWriteResultDto.js';
9
+ export interface XvfsWriteResultDtoDataEnvelope {
10
+ data: XvfsWriteResultDto;
11
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
package/package.json CHANGED
@@ -1,13 +1,14 @@
1
1
  {
2
2
  "name": "@xemahq/xema-shell-api-client",
3
- "version": "0.1.0",
3
+ "version": "0.2.0",
4
4
  "main": "./dist/index.js",
5
5
  "types": "./dist/index.d.ts",
6
6
  "files": [
7
7
  "dist"
8
8
  ],
9
9
  "publishConfig": {
10
- "registry": "https://npm.pkg.github.com"
10
+ "access": "public",
11
+ "registry": "https://registry.npmjs.org/"
11
12
  },
12
13
  "devDependencies": {
13
14
  "typescript": "5.9.3"
@@ -18,9 +19,19 @@
18
19
  "service": "xema-shell-api",
19
20
  "biome": "xema-shell",
20
21
  "target": "server",
21
- "generator": "@xemahq/api-client-generator@0.1.0",
22
+ "generator": "@xemahq/api-client-generator@0.2.0",
22
23
  "source": "openapi.public.json"
23
24
  },
25
+ "license": "LicenseRef-Xema-BSL-1.1",
26
+ "author": "Neuralchowder Inc. <developer@xema.dev> (https://xema.dev)",
27
+ "homepage": "https://xema.dev",
28
+ "bugs": "https://github.com/xema-dev/xema-community/issues",
29
+ "repository": {
30
+ "type": "git",
31
+ "url": "git+https://github.com/xema-dev/xema-community.git",
32
+ "directory": "packages/clients/xema-shell-api"
33
+ },
34
+ "description": "Generated public API client for the Xema xema-shell-api service.",
24
35
  "scripts": {
25
36
  "build": "tsc -p tsconfig.json"
26
37
  }
@@ -1,15 +0,0 @@
1
- /**
2
- * @summary Health check
3
- */
4
- export declare const getHealthControllerCheckUrl: () => string;
5
- export declare const healthControllerCheck: (options?: RequestInit) => Promise<void>;
6
- /**
7
- * @summary Liveness probe
8
- */
9
- export declare const getHealthControllerLiveUrl: () => string;
10
- export declare const healthControllerLive: (options?: RequestInit) => Promise<void>;
11
- /**
12
- * @summary Readiness probe
13
- */
14
- export declare const getHealthControllerReadyUrl: () => string;
15
- export declare const healthControllerReady: (options?: RequestInit) => Promise<void>;
@@ -1,53 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.healthControllerReady = exports.getHealthControllerReadyUrl = exports.healthControllerLive = exports.getHealthControllerLiveUrl = exports.healthControllerCheck = exports.getHealthControllerCheckUrl = void 0;
4
- /**
5
- * Generated by orval v8.6.2 🍺
6
- * Do not edit manually.
7
- * Xema Shell API
8
- * Xema Shell + XVFS. Phase 2 ships the read-only XVFS resolve endpoint; full Shell commands + websocket + write path land in Phase 5.
9
- * OpenAPI spec version: 0.1.0
10
- */
11
- const custom_fetch_1 = require("../../custom-fetch");
12
- /**
13
- * @summary Health check
14
- */
15
- const getHealthControllerCheckUrl = () => {
16
- return `/health`;
17
- };
18
- exports.getHealthControllerCheckUrl = getHealthControllerCheckUrl;
19
- const healthControllerCheck = async (options) => {
20
- return (0, custom_fetch_1.customFetch)((0, exports.getHealthControllerCheckUrl)(), {
21
- ...options,
22
- method: 'GET'
23
- });
24
- };
25
- exports.healthControllerCheck = healthControllerCheck;
26
- /**
27
- * @summary Liveness probe
28
- */
29
- const getHealthControllerLiveUrl = () => {
30
- return `/health/live`;
31
- };
32
- exports.getHealthControllerLiveUrl = getHealthControllerLiveUrl;
33
- const healthControllerLive = async (options) => {
34
- return (0, custom_fetch_1.customFetch)((0, exports.getHealthControllerLiveUrl)(), {
35
- ...options,
36
- method: 'GET'
37
- });
38
- };
39
- exports.healthControllerLive = healthControllerLive;
40
- /**
41
- * @summary Readiness probe
42
- */
43
- const getHealthControllerReadyUrl = () => {
44
- return `/health/ready`;
45
- };
46
- exports.getHealthControllerReadyUrl = getHealthControllerReadyUrl;
47
- const healthControllerReady = async (options) => {
48
- return (0, custom_fetch_1.customFetch)((0, exports.getHealthControllerReadyUrl)(), {
49
- ...options,
50
- method: 'GET'
51
- });
52
- };
53
- exports.healthControllerReady = healthControllerReady;