@flighthq/image-codec 0.3.0 → 0.3.1-next.1041.35b950c

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.
@@ -4,6 +4,7 @@ export * from './encodeImage';
4
4
  export * from './explainImageDecodeFailure';
5
5
  export * from './explainImageEncodeFailure';
6
6
  export * from './imageDecoderRegistry';
7
+ export * from './imageBitmapComposerRegistry';
7
8
  export * from './imageEncoderRegistry';
8
9
  export * from './registerWebImageDecoders';
9
10
  export * from './registerWebImageEncoders';
@@ -1 +1 @@
1
- {"version":3,"file":"contract.d.ts","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,eAAe,CAAC;AAC9B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC"}
1
+ {"version":3,"file":"contract.d.ts","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,eAAe,CAAC;AAC9B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AACvC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC"}
package/dist/contract.js CHANGED
@@ -4,6 +4,7 @@ export * from './encodeImage';
4
4
  export * from './explainImageDecodeFailure';
5
5
  export * from './explainImageEncodeFailure';
6
6
  export * from './imageDecoderRegistry';
7
+ export * from './imageBitmapComposerRegistry';
7
8
  export * from './imageEncoderRegistry';
8
9
  export * from './registerWebImageDecoders';
9
10
  export * from './registerWebImageEncoders';
@@ -1 +1 @@
1
- {"version":3,"file":"contract.js","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,eAAe,CAAC;AAC9B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC"}
1
+ {"version":3,"file":"contract.js","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,eAAe,CAAC;AAC9B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AACvC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC"}
@@ -0,0 +1,8 @@
1
+ import type { ImageBitmapComposer } from '@flighthq/types/contract';
2
+ export declare function clearImageBitmapComposers(): void;
3
+ export declare function getImageBitmapComposer(kind: string): ImageBitmapComposer | null;
4
+ export declare function getImageBitmapComposerKinds(): readonly string[];
5
+ export declare function hasImageBitmapComposer(kind: string): boolean;
6
+ export declare function registerImageBitmapComposer(kind: string, composer: ImageBitmapComposer): void;
7
+ export declare function unregisterImageBitmapComposer(kind: string): void;
8
+ //# sourceMappingURL=imageBitmapComposerRegistry.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"imageBitmapComposerRegistry.d.ts","sourceRoot":"","sources":["../src/imageBitmapComposerRegistry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAEpE,wBAAgB,yBAAyB,IAAI,IAAI,CAEhD;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,mBAAmB,GAAG,IAAI,CAE/E;AAED,wBAAgB,2BAA2B,IAAI,SAAS,MAAM,EAAE,CAE/D;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAE5D;AAED,wBAAgB,2BAA2B,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,mBAAmB,GAAG,IAAI,CAE7F;AAED,wBAAgB,6BAA6B,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAEhE"}
@@ -0,0 +1,23 @@
1
+ export function clearImageBitmapComposers() {
2
+ composers.clear();
3
+ }
4
+ export function getImageBitmapComposer(kind) {
5
+ return composers.get(kind) ?? null;
6
+ }
7
+ export function getImageBitmapComposerKinds() {
8
+ return Array.from(composers.keys());
9
+ }
10
+ export function hasImageBitmapComposer(kind) {
11
+ return composers.has(kind);
12
+ }
13
+ export function registerImageBitmapComposer(kind, composer) {
14
+ composers.set(kind, composer);
15
+ }
16
+ export function unregisterImageBitmapComposer(kind) {
17
+ composers.delete(kind);
18
+ }
19
+ // Open, format-neutral composer registry. A container puts only the stable key and payload bytes on a
20
+ // reference; its package owns the callback that understands those bytes. Last registration wins so an
21
+ // application can replace a built-in producer deliberately without embedding executable state in a scene.
22
+ const composers = new Map();
23
+ //# sourceMappingURL=imageBitmapComposerRegistry.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"imageBitmapComposerRegistry.js","sourceRoot":"","sources":["../src/imageBitmapComposerRegistry.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,yBAAyB;IACvC,SAAS,CAAC,KAAK,EAAE,CAAC;AACpB,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,IAAY;IACjD,OAAO,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;AACrC,CAAC;AAED,MAAM,UAAU,2BAA2B;IACzC,OAAO,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,IAAY;IACjD,OAAO,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AAC7B,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAC,IAAY,EAAE,QAA6B;IACrF,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AAChC,CAAC;AAED,MAAM,UAAU,6BAA6B,CAAC,IAAY;IACxD,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AACzB,CAAC;AAED,sGAAsG;AACtG,sGAAsG;AACtG,0GAA0G;AAC1G,MAAM,SAAS,GAAG,IAAI,GAAG,EAA+B,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@flighthq/image-codec",
3
- "version": "0.3.0",
3
+ "version": "0.3.1-next.1041.35b950c",
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.3.0"
41
+ "@flighthq/types": "0.3.1-next.1041.35b950c"
42
42
  },
43
43
  "devDependencies": {
44
44
  "typescript": "^5.3.0"
@@ -0,0 +1,72 @@
1
+ import type { ImageBitmapComposer } from '@flighthq/types/contract';
2
+
3
+ import {
4
+ clearImageBitmapComposers,
5
+ getImageBitmapComposer,
6
+ getImageBitmapComposerKinds,
7
+ hasImageBitmapComposer,
8
+ registerImageBitmapComposer,
9
+ unregisterImageBitmapComposer,
10
+ } from './imageBitmapComposerRegistry';
11
+
12
+ const composer: ImageBitmapComposer = () => null;
13
+
14
+ afterEach(() => {
15
+ clearImageBitmapComposers();
16
+ });
17
+
18
+ describe('clearImageBitmapComposers', () => {
19
+ it('removes every registered composer', () => {
20
+ registerImageBitmapComposer('acme/raw-raster', composer);
21
+ clearImageBitmapComposers();
22
+
23
+ expect(hasImageBitmapComposer('acme/raw-raster')).toBe(false);
24
+ });
25
+ });
26
+
27
+ describe('getImageBitmapComposer', () => {
28
+ it('returns the registered composer or null for a missing kind', () => {
29
+ expect(getImageBitmapComposer('acme/raw-raster')).toBeNull();
30
+ registerImageBitmapComposer('acme/raw-raster', composer);
31
+
32
+ expect(getImageBitmapComposer('acme/raw-raster')).toBe(composer);
33
+ });
34
+ });
35
+
36
+ describe('getImageBitmapComposerKinds', () => {
37
+ it('returns an insertion-ordered enumeration detached from registry state', () => {
38
+ registerImageBitmapComposer('acme/raw-raster', composer);
39
+ expect(getImageBitmapComposerKinds()).toEqual(['acme/raw-raster']);
40
+ (getImageBitmapComposerKinds() as string[]).length = 0;
41
+
42
+ expect(getImageBitmapComposerKinds()).toEqual(['acme/raw-raster']);
43
+ });
44
+ });
45
+
46
+ describe('hasImageBitmapComposer', () => {
47
+ it('reports whether a kind is registered', () => {
48
+ expect(hasImageBitmapComposer('acme/raw-raster')).toBe(false);
49
+ registerImageBitmapComposer('acme/raw-raster', composer);
50
+
51
+ expect(hasImageBitmapComposer('acme/raw-raster')).toBe(true);
52
+ });
53
+ });
54
+
55
+ describe('registerImageBitmapComposer', () => {
56
+ it('uses the final registration for a kind', () => {
57
+ const replacement: ImageBitmapComposer = () => null;
58
+ registerImageBitmapComposer('acme/raw-raster', composer);
59
+ registerImageBitmapComposer('acme/raw-raster', replacement);
60
+
61
+ expect(getImageBitmapComposer('acme/raw-raster')).toBe(replacement);
62
+ });
63
+ });
64
+
65
+ describe('unregisterImageBitmapComposer', () => {
66
+ it('removes one registered kind', () => {
67
+ registerImageBitmapComposer('acme/raw-raster', composer);
68
+ unregisterImageBitmapComposer('acme/raw-raster');
69
+
70
+ expect(getImageBitmapComposer('acme/raw-raster')).toBeNull();
71
+ });
72
+ });
@@ -6,6 +6,12 @@ import { registerWebImageDecoders } from './registerWebImageDecoders';
6
6
  // jsdom / node lack createImageBitmap + OffscreenCanvas + Blob; these minimal stand-ins let the
7
7
  // canvas decoder run. getImageData always returns straight (non-premultiplied) RGBA, matching the browser.
8
8
  const straightPixels = [200, 100, 50, 128];
9
+ let bitmapCloseMock: ReturnType<typeof vi.fn>;
10
+ let createImageBitmapMock: ReturnType<typeof vi.fn>;
11
+
12
+ class MockBlob {
13
+ constructor(readonly parts: readonly unknown[]) {}
14
+ }
9
15
 
10
16
  class MockOffscreenCanvas {
11
17
  constructor(
@@ -13,7 +19,8 @@ class MockOffscreenCanvas {
13
19
  readonly height: number,
14
20
  ) {}
15
21
 
16
- getContext(): unknown {
22
+ getContext(contextId: string): unknown {
23
+ if (contextId !== '2d') return null;
17
24
  return {
18
25
  drawImage: vi.fn(),
19
26
  getImageData: () => ({ data: new Uint8ClampedArray(straightPixels) }),
@@ -22,17 +29,11 @@ class MockOffscreenCanvas {
22
29
  }
23
30
 
24
31
  beforeEach(() => {
25
- vi.stubGlobal(
26
- 'createImageBitmap',
27
- vi.fn(async () => ({ width: 1, height: 1, close: vi.fn() })),
28
- );
32
+ bitmapCloseMock = vi.fn();
33
+ createImageBitmapMock = vi.fn(async () => ({ width: 1, height: 1, close: bitmapCloseMock }));
34
+ vi.stubGlobal('createImageBitmap', createImageBitmapMock);
29
35
  vi.stubGlobal('OffscreenCanvas', MockOffscreenCanvas);
30
- vi.stubGlobal(
31
- 'Blob',
32
- class {
33
- constructor(readonly parts: readonly unknown[]) {}
34
- },
35
- );
36
+ vi.stubGlobal('Blob', MockBlob);
36
37
  });
37
38
 
38
39
  afterEach(() => {
@@ -55,6 +56,18 @@ describe('registerWebImageDecoders', () => {
55
56
  expect(result.width).toBe(1);
56
57
  expect(result.height).toBe(1);
57
58
  expect(Array.from(result.data)).toEqual(straightPixels);
59
+ expect(bitmapCloseMock).toHaveBeenCalledOnce();
60
+ });
61
+
62
+ it('forwards only the bytes inside the supplied view to createImageBitmap', async () => {
63
+ registerWebImageDecoders();
64
+ const decoder = getImageDecoder('image/png');
65
+ const backing = new Uint8Array([1, 2, 3, 4, 5, 6]);
66
+
67
+ await decoder!(backing.subarray(1, 5));
68
+
69
+ const blob = createImageBitmapMock.mock.calls[0][0] as MockBlob;
70
+ expect(Array.from(blob.parts[0] as Uint8Array)).toEqual([2, 3, 4, 5]);
58
71
  });
59
72
 
60
73
  it('premultiplies the straight result when premultiplyAlpha is requested', async () => {
@@ -16,7 +16,8 @@ class MockOffscreenCanvas {
16
16
  readonly height: number,
17
17
  ) {}
18
18
 
19
- getContext(): unknown {
19
+ getContext(contextId: string): unknown {
20
+ if (contextId !== '2d') return null;
20
21
  return { putImageData: vi.fn() };
21
22
  }
22
23
 
@@ -25,22 +26,25 @@ class MockOffscreenCanvas {
25
26
  }
26
27
  }
27
28
 
29
+ class MockImageData {
30
+ constructor(
31
+ readonly data: Uint8ClampedArray,
32
+ readonly width: number,
33
+ readonly height: number,
34
+ ) {
35
+ if (data.length !== width * height * 4) {
36
+ throw new DOMException('ImageData data length must equal width * height * 4', 'IndexSizeError');
37
+ }
38
+ }
39
+ }
40
+
28
41
  function fakeImage(): DecodedImage {
29
42
  return { data: new Uint8ClampedArray([10, 20, 30, 255]), width: 1, height: 1 };
30
43
  }
31
44
 
32
45
  beforeEach(() => {
33
46
  vi.stubGlobal('OffscreenCanvas', MockOffscreenCanvas);
34
- vi.stubGlobal(
35
- 'ImageData',
36
- class {
37
- constructor(
38
- readonly data: Uint8ClampedArray,
39
- readonly width: number,
40
- readonly height: number,
41
- ) {}
42
- },
43
- );
47
+ vi.stubGlobal('ImageData', MockImageData);
44
48
  });
45
49
 
46
50
  afterEach(() => {