@flighthq/shell 0.5.1-next.1350.8ce488b → 0.5.1-next.1404.457d1da
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 +2 -2
- package/dist/shell.d.ts +10 -10
- package/dist/shell.d.ts.map +1 -1
- package/dist/shell.js.map +1 -1
- package/package.json +2 -2
- package/src/shell.test.ts +23 -23
package/README.md
CHANGED
|
@@ -13,5 +13,5 @@ Import the supported application-facing API from `@flighthq/shell`. The `@flight
|
|
|
13
13
|
This package is part of the locked-version Flight SDK graph. Applications may instead install and import `@flighthq/sdk` when package-level tree shaking is sufficient.
|
|
14
14
|
|
|
15
15
|
- [Flight project](https://github.com/flighthq/flight)
|
|
16
|
-
- [Source for @flighthq/shell@0.5.1-next.
|
|
17
|
-
- [License](https://github.com/flighthq/flight/blob/
|
|
16
|
+
- [Source for @flighthq/shell@0.5.1-next.1404.457d1da](https://github.com/flighthq/flight/tree/457d1da918a60be5853b84eb6c25530a66662cef/packages/shell)
|
|
17
|
+
- [License](https://github.com/flighthq/flight/blob/457d1da918a60be5853b84eb6c25530a66662cef/LICENSE.md)
|
package/dist/shell.d.ts
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { HostShellBeepCapability, HostShellExternalCapability, HostShellPathOpenCapability, HostShellPathRevealCapability, HostShellProcessCapability, HostShellShortcutLinkCapability, HostShellTrashCapability, ShellExternalOutcome, ShellExternalUrlPolicy, ShellPathOpenOutcome, ShellPathRevealOutcome, ShellProcess, ShellProcessOptions, ShellShortcutLink, ShellShortcutLinkReadOutcome, ShellShortcutLinkWriteOutcome, ShellShortcutWriteOperation, ShellTrashOutcome } from '@flighthq/types/contract';
|
|
2
2
|
export declare function isShellUrlAllowed(url: string, policy: Readonly<ShellExternalUrlPolicy>): boolean;
|
|
3
|
-
export declare function moveShellItemsToTrash(hostShellTrash: Readonly<
|
|
4
|
-
export declare function moveShellItemToTrash(hostShellTrash: Readonly<
|
|
5
|
-
export declare function openShellExternalUrl(hostShellExternal: Readonly<
|
|
6
|
-
export declare function openShellPath(hostShellPathOpen: Readonly<
|
|
7
|
-
export declare function readShellShortcutLink(hostShellShortcutLink: Readonly<
|
|
8
|
-
export declare function revealShellPath(hostShellPathReveal: Readonly<
|
|
9
|
-
export declare function shellBeep(hostShellBeep: Readonly<
|
|
10
|
-
export declare function spawnShellProcess(hostShellProcess: Readonly<
|
|
11
|
-
export declare function writeShellShortcutLink(hostShellShortcutLink: Readonly<
|
|
3
|
+
export declare function moveShellItemsToTrash(hostShellTrash: Readonly<HostShellTrashCapability>, paths: readonly string[]): Promise<readonly ShellTrashOutcome[]>;
|
|
4
|
+
export declare function moveShellItemToTrash(hostShellTrash: Readonly<HostShellTrashCapability>, path: string): Promise<ShellTrashOutcome>;
|
|
5
|
+
export declare function openShellExternalUrl(hostShellExternal: Readonly<HostShellExternalCapability>, url: string, policy: Readonly<ShellExternalUrlPolicy>): Promise<ShellExternalOutcome>;
|
|
6
|
+
export declare function openShellPath(hostShellPathOpen: Readonly<HostShellPathOpenCapability>, path: string): Promise<ShellPathOpenOutcome>;
|
|
7
|
+
export declare function readShellShortcutLink(hostShellShortcutLink: Readonly<HostShellShortcutLinkCapability>, shortcutPath: string): Promise<ShellShortcutLinkReadOutcome>;
|
|
8
|
+
export declare function revealShellPath(hostShellPathReveal: Readonly<HostShellPathRevealCapability>, path: string): Promise<ShellPathRevealOutcome>;
|
|
9
|
+
export declare function shellBeep(hostShellBeep: Readonly<HostShellBeepCapability>): void;
|
|
10
|
+
export declare function spawnShellProcess(hostShellProcess: Readonly<HostShellProcessCapability>, command: string, args: readonly string[], options?: Readonly<ShellProcessOptions>): ShellProcess;
|
|
11
|
+
export declare function writeShellShortcutLink(hostShellShortcutLink: Readonly<HostShellShortcutLinkCapability>, shortcutPath: string, link: Readonly<ShellShortcutLink>, operation: ShellShortcutWriteOperation): Promise<ShellShortcutLinkWriteOutcome>;
|
|
12
12
|
//# sourceMappingURL=shell.d.ts.map
|
package/dist/shell.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"shell.d.ts","sourceRoot":"","sources":["../src/shell.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,
|
|
1
|
+
{"version":3,"file":"shell.d.ts","sourceRoot":"","sources":["../src/shell.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,uBAAuB,EACvB,2BAA2B,EAC3B,2BAA2B,EAC3B,6BAA6B,EAC7B,0BAA0B,EAC1B,+BAA+B,EAC/B,wBAAwB,EACxB,oBAAoB,EACpB,sBAAsB,EACtB,oBAAoB,EACpB,sBAAsB,EACtB,YAAY,EACZ,mBAAmB,EACnB,iBAAiB,EACjB,4BAA4B,EAC5B,6BAA6B,EAC7B,2BAA2B,EAC3B,iBAAiB,EAClB,MAAM,0BAA0B,CAAC;AAIlC,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,sBAAsB,CAAC,GAAG,OAAO,CAOhG;AAID,wBAAgB,qBAAqB,CACnC,cAAc,EAAE,QAAQ,CAAC,wBAAwB,CAAC,EAClD,KAAK,EAAE,SAAS,MAAM,EAAE,GACvB,OAAO,CAAC,SAAS,iBAAiB,EAAE,CAAC,CAEvC;AAED,wBAAgB,oBAAoB,CAClC,cAAc,EAAE,QAAQ,CAAC,wBAAwB,CAAC,EAClD,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,iBAAiB,CAAC,CAE5B;AAKD,wBAAgB,oBAAoB,CAClC,iBAAiB,EAAE,QAAQ,CAAC,2BAA2B,CAAC,EACxD,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,QAAQ,CAAC,sBAAsB,CAAC,GACvC,OAAO,CAAC,oBAAoB,CAAC,CAG/B;AAED,wBAAgB,aAAa,CAC3B,iBAAiB,EAAE,QAAQ,CAAC,2BAA2B,CAAC,EACxD,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,oBAAoB,CAAC,CAE/B;AAED,wBAAgB,qBAAqB,CACnC,qBAAqB,EAAE,QAAQ,CAAC,+BAA+B,CAAC,EAChE,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,4BAA4B,CAAC,CAEvC;AAED,wBAAgB,eAAe,CAC7B,mBAAmB,EAAE,QAAQ,CAAC,6BAA6B,CAAC,EAC5D,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,sBAAsB,CAAC,CAEjC;AAED,wBAAgB,SAAS,CAAC,aAAa,EAAE,QAAQ,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAEhF;AAED,wBAAgB,iBAAiB,CAC/B,gBAAgB,EAAE,QAAQ,CAAC,0BAA0B,CAAC,EACtD,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,SAAS,MAAM,EAAE,EACvB,OAAO,CAAC,EAAE,QAAQ,CAAC,mBAAmB,CAAC,GACtC,YAAY,CAEd;AAED,wBAAgB,sBAAsB,CACpC,qBAAqB,EAAE,QAAQ,CAAC,+BAA+B,CAAC,EAChE,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,QAAQ,CAAC,iBAAiB,CAAC,EACjC,SAAS,EAAE,2BAA2B,GACrC,OAAO,CAAC,6BAA6B,CAAC,CAExC"}
|
package/dist/shell.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"shell.js","sourceRoot":"","sources":["../src/shell.ts"],"names":[],"mappings":"AAqBA,sGAAsG;AACtG,4FAA4F;AAC5F,MAAM,UAAU,iBAAiB,CAAC,GAAW,EAAE,MAAwC;IACrF,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;QACrE,OAAO,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC,CAAC;IACnF,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,iGAAiG;AACjG,4EAA4E;AAC5E,MAAM,UAAU,qBAAqB,CACnC,
|
|
1
|
+
{"version":3,"file":"shell.js","sourceRoot":"","sources":["../src/shell.ts"],"names":[],"mappings":"AAqBA,sGAAsG;AACtG,4FAA4F;AAC5F,MAAM,UAAU,iBAAiB,CAAC,GAAW,EAAE,MAAwC;IACrF,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;QACrE,OAAO,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC,CAAC;IACnF,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,iGAAiG;AACjG,4EAA4E;AAC5E,MAAM,UAAU,qBAAqB,CACnC,cAAkD,EAClD,KAAwB;IAExB,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAC5E,CAAC;AAED,MAAM,UAAU,oBAAoB,CAClC,cAAkD,EAClD,IAAY;IAEZ,OAAO,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;AAC1C,CAAC;AAED,qGAAqG;AACrG,mGAAmG;AACnG,wFAAwF;AACxF,MAAM,UAAU,oBAAoB,CAClC,iBAAwD,EACxD,GAAW,EACX,MAAwC;IAExC,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,MAAM,CAAC;QAAE,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC,CAAC;IAC1F,OAAO,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACrC,CAAC;AAED,MAAM,UAAU,aAAa,CAC3B,iBAAwD,EACxD,IAAY;IAEZ,OAAO,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,qBAAqB,CACnC,qBAAgE,EAChE,YAAoB;IAEpB,OAAO,qBAAqB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,UAAU,eAAe,CAC7B,mBAA4D,EAC5D,IAAY;IAEZ,OAAO,mBAAmB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AAC1C,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,aAAgD;IACxE,aAAa,CAAC,IAAI,EAAE,CAAC;AACvB,CAAC;AAED,MAAM,UAAU,iBAAiB,CAC/B,gBAAsD,EACtD,OAAe,EACf,IAAuB,EACvB,OAAuC;IAEvC,OAAO,gBAAgB,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AACxD,CAAC;AAED,MAAM,UAAU,sBAAsB,CACpC,qBAAgE,EAChE,YAAoB,EACpB,IAAiC,EACjC,SAAsC;IAEtC,OAAO,qBAAqB,CAAC,KAAK,CAAC,YAAY,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;AACpE,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@flighthq/shell",
|
|
3
|
-
"version": "0.5.1-next.
|
|
3
|
+
"version": "0.5.1-next.1404.457d1da",
|
|
4
4
|
"author": "Joshua Granick and other contributors",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
"clean:dist": "tsx ../../scripts/clean-package-dist.ts"
|
|
39
39
|
},
|
|
40
40
|
"dependencies": {
|
|
41
|
-
"@flighthq/types": "0.5.1-next.
|
|
41
|
+
"@flighthq/types": "0.5.1-next.1404.457d1da"
|
|
42
42
|
},
|
|
43
43
|
"devDependencies": {
|
|
44
44
|
"@flighthq/entity": "*",
|
package/src/shell.test.ts
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
import { allocateEntity, finishEntity } from '@flighthq/entity/contract';
|
|
2
2
|
import type {
|
|
3
3
|
EntityRuntimeKey,
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
4
|
+
HostShellBeepCapability,
|
|
5
|
+
HostShellExternalCapability,
|
|
6
|
+
HostShellPathOpenCapability,
|
|
7
|
+
HostShellPathRevealCapability,
|
|
8
|
+
HostShellShortcutLinkCapability,
|
|
9
|
+
HostShellTrashCapability,
|
|
10
10
|
ShellExternalUrlPolicy,
|
|
11
11
|
ShellProcess,
|
|
12
|
-
|
|
12
|
+
HostShellProcessCapability,
|
|
13
13
|
ShellProcessOptions,
|
|
14
14
|
} from '@flighthq/types/contract';
|
|
15
15
|
|
|
@@ -91,7 +91,7 @@ describe('moveShellItemToTrash', () => {
|
|
|
91
91
|
describe('openShellExternalUrl', () => {
|
|
92
92
|
it('requires policy as the third parameter at the type boundary', () => {
|
|
93
93
|
expectTypeOf(openShellExternalUrl).parameters.toEqualTypeOf<
|
|
94
|
-
[Readonly<
|
|
94
|
+
[Readonly<HostShellExternalCapability>, string, Readonly<ShellExternalUrlPolicy>]
|
|
95
95
|
>();
|
|
96
96
|
});
|
|
97
97
|
|
|
@@ -146,7 +146,7 @@ describe('openShellExternalUrl', () => {
|
|
|
146
146
|
|
|
147
147
|
describe('openShellPath', () => {
|
|
148
148
|
it('preserves a provider failure and its message', async () => {
|
|
149
|
-
const provider = allocateEntity<
|
|
149
|
+
const provider = allocateEntity<HostShellPathOpenCapability>();
|
|
150
150
|
provider.open = async () => {
|
|
151
151
|
return { message: '', reason: 'operation-failed' as const };
|
|
152
152
|
};
|
|
@@ -206,7 +206,7 @@ describe('shellBeep', () => {
|
|
|
206
206
|
describe('spawnShellProcess', () => {
|
|
207
207
|
it('exposes the explicit host, command, argument-vector, and optional-options API', () => {
|
|
208
208
|
expectTypeOf(spawnShellProcess).parameters.toEqualTypeOf<
|
|
209
|
-
[Readonly<
|
|
209
|
+
[Readonly<HostShellProcessCapability>, string, readonly string[], Readonly<ShellProcessOptions>?]
|
|
210
210
|
>();
|
|
211
211
|
expectTypeOf(spawnShellProcess).returns.toEqualTypeOf<ShellProcess>();
|
|
212
212
|
});
|
|
@@ -241,30 +241,30 @@ describe('writeShellShortcutLink', () => {
|
|
|
241
241
|
|
|
242
242
|
const HTTPS_ONLY: ShellExternalUrlPolicy = { allowedSchemes: ['https'] };
|
|
243
243
|
|
|
244
|
-
function beepHost(beep:
|
|
244
|
+
function beepHost(beep: HostShellBeepCapability): { readonly shell: { readonly beep: HostShellBeepCapability } } {
|
|
245
245
|
return { shell: { beep } };
|
|
246
246
|
}
|
|
247
247
|
|
|
248
|
-
function externalHost(external:
|
|
249
|
-
readonly shell: { readonly external:
|
|
248
|
+
function externalHost(external: HostShellExternalCapability): {
|
|
249
|
+
readonly shell: { readonly external: HostShellExternalCapability };
|
|
250
250
|
} {
|
|
251
251
|
return { shell: { external } };
|
|
252
252
|
}
|
|
253
253
|
|
|
254
|
-
function pathOpenHost(pathOpen:
|
|
255
|
-
readonly shell: { readonly pathOpen:
|
|
254
|
+
function pathOpenHost(pathOpen: HostShellPathOpenCapability): {
|
|
255
|
+
readonly shell: { readonly pathOpen: HostShellPathOpenCapability };
|
|
256
256
|
} {
|
|
257
257
|
return { shell: { pathOpen } };
|
|
258
258
|
}
|
|
259
259
|
|
|
260
|
-
function pathRevealHost(pathReveal:
|
|
261
|
-
readonly shell: { readonly pathReveal:
|
|
260
|
+
function pathRevealHost(pathReveal: HostShellPathRevealCapability): {
|
|
261
|
+
readonly shell: { readonly pathReveal: HostShellPathRevealCapability };
|
|
262
262
|
} {
|
|
263
263
|
return { shell: { pathReveal } };
|
|
264
264
|
}
|
|
265
265
|
|
|
266
|
-
function processHost(process:
|
|
267
|
-
readonly shell: { readonly process:
|
|
266
|
+
function processHost(process: HostShellProcessCapability): {
|
|
267
|
+
readonly shell: { readonly process: HostShellProcessCapability };
|
|
268
268
|
} {
|
|
269
269
|
return { shell: { process } };
|
|
270
270
|
}
|
|
@@ -279,13 +279,13 @@ function shellProcess(): ShellProcess {
|
|
|
279
279
|
return finishEntity(out);
|
|
280
280
|
}
|
|
281
281
|
|
|
282
|
-
function shortcutLinkHost(shortcutLink:
|
|
283
|
-
readonly shell: { readonly shortcutLink:
|
|
282
|
+
function shortcutLinkHost(shortcutLink: HostShellShortcutLinkCapability): {
|
|
283
|
+
readonly shell: { readonly shortcutLink: HostShellShortcutLinkCapability };
|
|
284
284
|
} {
|
|
285
285
|
return { shell: { shortcutLink } };
|
|
286
286
|
}
|
|
287
287
|
|
|
288
|
-
function shortcutLinkProvider():
|
|
288
|
+
function shortcutLinkProvider(): HostShellShortcutLinkCapability & { write: ReturnType<typeof vi.fn> } {
|
|
289
289
|
const out = allocateEntity<any>();
|
|
290
290
|
out.read = async () => {
|
|
291
291
|
return { link: { target: '/app' }, reason: 'ok' };
|
|
@@ -294,6 +294,6 @@ function shortcutLinkProvider(): HostShellShortcutLinkProvider & { write: Return
|
|
|
294
294
|
return finishEntity(out);
|
|
295
295
|
}
|
|
296
296
|
|
|
297
|
-
function trashHost(trash:
|
|
297
|
+
function trashHost(trash: HostShellTrashCapability): { readonly shell: { readonly trash: HostShellTrashCapability } } {
|
|
298
298
|
return { shell: { trash } };
|
|
299
299
|
}
|