@nonstrict/recordkit 0.87.2 → 0.97.0

package/bin/README.md

@@ -1 +1 @@
-# recordkit-rpc 0.87.2
+# recordkit-rpc 0.97.0

package/out/Errors.d.ts

@@ -0,0 +1,91 @@
+/**
+ * The set of error code names that can occur in RecordKit.
+ *
+ * Each member is the exact case-name string returned by the Swift
+ * `RKError.Code.description` and reported as `RecordKitError.code`. The trailing
+ * comment on each line is the matching numeric raw value, available at runtime
+ * as `RecordKitError.codeNumber` (see {@link RECORDKIT_ERROR_CODE_NUMBERS}).
+ *
+ * @remarks
+ * Codes are grouped into ranges by category, mirroring the Swift `RKError.Code`
+ * enum. The associated `RecordKitError` carries a user-facing message
+ * (`message`) and technical detail; the meaning of each code:
+ *
+ * - **Configuration** (`-100x`):
+ *   `invalidLicense` (no valid RecordKit license),
+ *   `invalidConfiguration` (the provided configuration is not valid).
+ * - **Permission** (`-110x`): the corresponding permission is required but not
+ *   granted — `microphonePermissionRequired`, `cameraPermissionRequired`,
+ *   `screenRecordingPermissionRequired`, `systemAudioPermissionRequired`.
+ * - **Device availability** (`-120x`): the requested device/source is
+ *   unavailable for recording — `microphoneUnavailable`, `cameraUnavailable`,
+ *   `displayUnavailable`, `windowUnavailable`, `systemAudioUnavailable`,
+ *   `appleDeviceUnavailable`, `inputRecordingUnavailable`.
+ * - **Recording state** (`-130x`): `noVideoFramesReceived` /
+ *   `noAudioSamplesReceived` (nothing was captured), `screenCaptureStoppedLowDiskSpace`,
+ *   `screenCaptureStoppedWithError`, `screenCaptureStoppedWithoutError`,
+ *   `insufficientDiskSpace` (not enough free disk space to start or continue the recording).
+ * - **Internal** (`-16xx`): unexpected failures inside RecordKit (e.g.
+ *   `internalError`, `uncaughtError`, `internalConductorError`,
+ *   `configurationFailed`, `configurationNotSupported`, audio/video/media
+ *   format and device init/configuration failures, `assetWriterFailed`,
+ *   `tccUnavailableError` — the permission system interface is unavailable).
+ * - **Processing/operation** (`-17xx`): a runtime operation failed — e.g.
+ *   `audioProcessingFailed`, `audioBufferProcessingFailed`,
+ *   `audioBufferCreationFailed`, `inputEventProcessingFailed`,
+ *   `assetWriterCreationFailed`, `fileOperationFailed`, `windowOperationFailed`.
+ *
+ * @group Recording
+ */
+export type RecordKitErrorCode = 'invalidLicense' | 'invalidConfiguration' | 'microphonePermissionRequired' | 'cameraPermissionRequired' | 'screenRecordingPermissionRequired' | 'systemAudioPermissionRequired' | 'microphoneUnavailable' | 'cameraUnavailable' | 'displayUnavailable' | 'windowUnavailable' | 'systemAudioUnavailable' | 'appleDeviceUnavailable' | 'inputRecordingUnavailable' | 'noVideoFramesReceived' | 'noAudioSamplesReceived' | 'screenCaptureStoppedLowDiskSpace' | 'screenCaptureStoppedWithError' | 'screenCaptureStoppedWithoutError' | 'insufficientDiskSpace' | 'internalError' | 'uncaughtError' | 'internalConductorError' | 'configurationFailed' | 'configurationNotSupported' | 'audioFormatError' | 'videoFormatError' | 'audioFormatConfigurationFailed' | 'videoFormatConfigurationFailed' | 'mediaFormatInitializationFailed' | 'mediaFormatConfigurationFailed' | 'audioDeviceInitializationFailed' | 'audioDeviceConfigurationFailed' | 'assetWriterFailed' | 'tccUnavailableError' | 'audioProcessingFailed' | 'audioBufferProcessingFailed' | 'audioBufferCreationFailed' | 'inputEventProcessingFailed' | 'assetWriterCreationFailed' | 'fileOperationFailed' | 'windowOperationFailed';
+/**
+ * Mapping from each {@link RecordKitErrorCode} name to its numeric raw value.
+ *
+ * The numbers correspond to the `Int` raw values of the Swift `RKError.Code`
+ * enum and to the `RecordKitError.codeNumber` reported over RPC.
+ *
+ * @group Recording
+ */
+export declare const RECORDKIT_ERROR_CODE_NUMBERS: {
+    readonly invalidLicense: -1001;
+    readonly invalidConfiguration: -1002;
+    readonly microphonePermissionRequired: -1101;
+    readonly cameraPermissionRequired: -1102;
+    readonly screenRecordingPermissionRequired: -1103;
+    readonly systemAudioPermissionRequired: -1104;
+    readonly microphoneUnavailable: -1201;
+    readonly cameraUnavailable: -1202;
+    readonly displayUnavailable: -1203;
+    readonly windowUnavailable: -1204;
+    readonly systemAudioUnavailable: -1205;
+    readonly appleDeviceUnavailable: -1206;
+    readonly inputRecordingUnavailable: -1207;
+    readonly noVideoFramesReceived: -1301;
+    readonly noAudioSamplesReceived: -1302;
+    readonly screenCaptureStoppedLowDiskSpace: -1303;
+    readonly screenCaptureStoppedWithError: -1304;
+    readonly screenCaptureStoppedWithoutError: -1305;
+    readonly insufficientDiskSpace: -1306;
+    readonly internalError: -1600;
+    readonly uncaughtError: -1601;
+    readonly internalConductorError: -1602;
+    readonly configurationFailed: -1603;
+    readonly configurationNotSupported: -1604;
+    readonly audioFormatError: -1605;
+    readonly videoFormatError: -1606;
+    readonly audioFormatConfigurationFailed: -1607;
+    readonly videoFormatConfigurationFailed: -1608;
+    readonly mediaFormatInitializationFailed: -1609;
+    readonly mediaFormatConfigurationFailed: -1610;
+    readonly audioDeviceInitializationFailed: -1611;
+    readonly audioDeviceConfigurationFailed: -1612;
+    readonly assetWriterFailed: -1613;
+    readonly tccUnavailableError: -1614;
+    readonly audioProcessingFailed: -1701;
+    readonly audioBufferProcessingFailed: -1702;
+    readonly audioBufferCreationFailed: -1703;
+    readonly inputEventProcessingFailed: -1704;
+    readonly assetWriterCreationFailed: -1705;
+    readonly fileOperationFailed: -1706;
+    readonly windowOperationFailed: -1707;
+};

package/out/Errors.js

@@ -0,0 +1,63 @@
+// Error code types mirroring RecordKit's `RKError` / `RKError.Code` Swift enum, JSON-for-JSON, as
+// surfaced over the RPC bridge. `RecordKitError.code` carries the Swift case name (from
+// `RKError.Code.description`) and `RecordKitError.codeNumber` the corresponding `Int` raw value;
+// user-facing text is on `RecordKitError.message`, technical detail on `RecordKitError.debugDescription`.
+// See the RecordKitErrorCode docs below and https://recordkit.dev/guides/logging-and-errors#error-handling
+/**
+ * Mapping from each {@link RecordKitErrorCode} name to its numeric raw value.
+ *
+ * The numbers correspond to the `Int` raw values of the Swift `RKError.Code`
+ * enum and to the `RecordKitError.codeNumber` reported over RPC.
+ *
+ * @group Recording
+ */
+export const RECORDKIT_ERROR_CODE_NUMBERS = {
+    // Configuration Errors
+    invalidLicense: -1001,
+    invalidConfiguration: -1002,
+    // Permission Errors
+    microphonePermissionRequired: -1101,
+    cameraPermissionRequired: -1102,
+    screenRecordingPermissionRequired: -1103,
+    systemAudioPermissionRequired: -1104,
+    // Device Availability Errors
+    microphoneUnavailable: -1201,
+    cameraUnavailable: -1202,
+    displayUnavailable: -1203,
+    windowUnavailable: -1204,
+    systemAudioUnavailable: -1205,
+    appleDeviceUnavailable: -1206,
+    inputRecordingUnavailable: -1207,
+    // Recording State Errors
+    noVideoFramesReceived: -1301,
+    noAudioSamplesReceived: -1302,
+    screenCaptureStoppedLowDiskSpace: -1303,
+    screenCaptureStoppedWithError: -1304,
+    screenCaptureStoppedWithoutError: -1305,
+    insufficientDiskSpace: -1306,
+    // Internal Errors
+    internalError: -1600,
+    uncaughtError: -1601,
+    internalConductorError: -1602,
+    configurationFailed: -1603,
+    configurationNotSupported: -1604,
+    audioFormatError: -1605,
+    videoFormatError: -1606,
+    audioFormatConfigurationFailed: -1607,
+    videoFormatConfigurationFailed: -1608,
+    mediaFormatInitializationFailed: -1609,
+    mediaFormatConfigurationFailed: -1610,
+    audioDeviceInitializationFailed: -1611,
+    audioDeviceConfigurationFailed: -1612,
+    assetWriterFailed: -1613,
+    tccUnavailableError: -1614,
+    // Processing/Operation Errors
+    audioProcessingFailed: -1701,
+    audioBufferProcessingFailed: -1702,
+    audioBufferCreationFailed: -1703,
+    inputEventProcessingFailed: -1704,
+    assetWriterCreationFailed: -1705,
+    fileOperationFailed: -1706,
+    windowOperationFailed: -1707,
+};
+//# sourceMappingURL=Errors.js.map

package/out/Errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Errors.js","sourceRoot":"","sources":["../src/Errors.ts"],"names":[],"mappings":"AAAA,kGAAkG;AAClG,wFAAwF;AACxF,iGAAiG;AACjG,0GAA0G;AAC1G,2GAA2G;AA0F3G;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG;IAC1C,uBAAuB;IACvB,cAAc,EAAE,CAAC,IAAI;IACrB,oBAAoB,EAAE,CAAC,IAAI;IAC3B,oBAAoB;IACpB,4BAA4B,EAAE,CAAC,IAAI;IACnC,wBAAwB,EAAE,CAAC,IAAI;IAC/B,iCAAiC,EAAE,CAAC,IAAI;IACxC,6BAA6B,EAAE,CAAC,IAAI;IACpC,6BAA6B;IAC7B,qBAAqB,EAAE,CAAC,IAAI;IAC5B,iBAAiB,EAAE,CAAC,IAAI;IACxB,kBAAkB,EAAE,CAAC,IAAI;IACzB,iBAAiB,EAAE,CAAC,IAAI;IACxB,sBAAsB,EAAE,CAAC,IAAI;IAC7B,sBAAsB,EAAE,CAAC,IAAI;IAC7B,yBAAyB,EAAE,CAAC,IAAI;IAChC,yBAAyB;IACzB,qBAAqB,EAAE,CAAC,IAAI;IAC5B,sBAAsB,EAAE,CAAC,IAAI;IAC7B,gCAAgC,EAAE,CAAC,IAAI;IACvC,6BAA6B,EAAE,CAAC,IAAI;IACpC,gCAAgC,EAAE,CAAC,IAAI;IACvC,qBAAqB,EAAE,CAAC,IAAI;IAC5B,kBAAkB;IAClB,aAAa,EAAE,CAAC,IAAI;IACpB,aAAa,EAAE,CAAC,IAAI;IACpB,sBAAsB,EAAE,CAAC,IAAI;IAC7B,mBAAmB,EAAE,CAAC,IAAI;IAC1B,yBAAyB,EAAE,CAAC,IAAI;IAChC,gBAAgB,EAAE,CAAC,IAAI;IACvB,gBAAgB,EAAE,CAAC,IAAI;IACvB,8BAA8B,EAAE,CAAC,IAAI;IACrC,8BAA8B,EAAE,CAAC,IAAI;IACrC,+BAA+B,EAAE,CAAC,IAAI;IACtC,8BAA8B,EAAE,CAAC,IAAI;IACrC,+BAA+B,EAAE,CAAC,IAAI;IACtC,8BAA8B,EAAE,CAAC,IAAI;IACrC,iBAAiB,EAAE,CAAC,IAAI;IACxB,mBAAmB,EAAE,CAAC,IAAI;IAC1B,8BAA8B;IAC9B,qBAAqB,EAAE,CAAC,IAAI;IAC5B,2BAA2B,EAAE,CAAC,IAAI;IAClC,yBAAyB,EAAE,CAAC,IAAI;IAChC,0BAA0B,EAAE,CAAC,IAAI;IACjC,yBAAyB,EAAE,CAAC,IAAI;IAChC,mBAAmB,EAAE,CAAC,IAAI;IAC1B,qBAAqB,EAAE,CAAC,IAAI;CACyB,CAAC"}