# @skgrush/bplist-and-nskeyedunarchiver

> Tool for deserializing binary plist files and NSKeyedUnarchiver-coded files

Latest version **0.0.1-rc.2** (published 2024-02-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install @skgrush/bplist-and-nskeyedunarchiver
pnpm add @skgrush/bplist-and-nskeyedunarchiver
yarn add @skgrush/bplist-and-nskeyedunarchiver
bun add @skgrush/bplist-and-nskeyedunarchiver
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1-rc.2 |
| Published | 2024-02-09 |
| First published | 2024-02-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 225 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Samuel K. Grush |
| Maintainers | skgrush |
| Keywords | plist, bplist, NSKeyedUnarchiver |

## Links

- npm: https://www.npmjs.com/package/@skgrush/bplist-and-nskeyedunarchiver
- Repository: https://github.com/skgrush/BPlist-and-NSKeyedUnarchiver
- Homepage: https://github.com/skgrush/BPlist-and-NSKeyedUnarchiver#readme
- Issues: https://github.com/skgrush/BPlist-and-NSKeyedUnarchiver/issues
- npm.io page: https://npm.io/package/@skgrush/bplist-and-nskeyedunarchiver

## Alternatives

- [lodash.startswith](https://npm.io/package/lodash.startswith.md) — 769.7K weekly downloads
- [@tarojs/service](https://npm.io/package/@tarojs/service.md) — 33.9K weekly downloads
- [io.extendreality.tilia.indicators.spatialtargets.unity](https://npm.io/package/io.extendreality.tilia.indicators.spatialtargets.unity.md) — 131 weekly downloads
- [@rtarojs/taro](https://npm.io/package/@rtarojs/taro.md) — 90 weekly downloads
- [node-branch-io](https://npm.io/package/node-branch-io.md) — 50 weekly downloads

## Recent versions

- 0.0.1-rc.2 (latest) — 2024-02-09
- 0.0.1-rc.1 — 2024-02-04

## README

# BPlist-and-NSKeyedUnarchiver

> Tool for deserializing binary plist files and NSKeyedUnarchiver-coded files.

## Origin and licensing

Based on the implementation in Apple's open-sourced [CFBinaryPList.c](https://opensource.apple.com/source/CF/CF-550/CFBinaryPList.c), licensed under APSL v2.0.
As a result, this code is likely a derivative work of said code,
therefore this code and all changes to it will be made public,
along with a copy of the
APSL v2 in [OriginalCode.APSL.LICENSE](./OriginalCode.APSL.LICENSE).

**However**, as this code does not use any of the original C code, original
or modified, I feel mildly comfortable in licensing this project as MIT, as
long as the source-publishing criteria are met.


## Usage

### BPlist

These examples show reading a file (in Node and in the Browser)
and parsing the top-level BPlist object from it.

#### Node

```ts
const { readFile } = require('node:fs/promises'); 
const { Reader } = require('@skgrush/bplist-and-nskeyedunarchiver/bplist');
const { buildLeveledLogger, LogLevel } = require('@skgrush/bplist-and-nskeyedunarchiver/share');

async function readBPlistFromFilePath(filePath: string) {
  const nodeBuffer = await readFile(filePath);
  const arrayBuffer = nodeBuffer.buffer.slice(
    nodeBuffer.byteoffset,
    nodeBuffer.byteOffset + nodeBuffer.byteLength,
  );

  const logger = buildLeveledLogger({ logger: console, level: LogLevel.warn });
  const reader = new Reader(arrayBuffer, logger);

  const object = reader.buildTopLevelObject();
}
```

#### Browser

```ts
import { Reader } from '@skgrush/bplist-and-nskeyedunarchiver/bplist/reader';

async function readBPlistFromBlob(blob: Blob) {
  const arrayBuffer = await blob.arrayBuffer();

  const logger = buildLeveledLogger({ logger: console, level: LogLevel.warn });
  const reader = new Reader(arrayBuffer, logger);

  return reader.buildTopLevelObject();
}
```

### NSKeyedUnarchiver

This example provides examples of how to unarchive a custom class containing some native NS types,
including arrays of other custom class.

```ts
import { Reader } from '@skgrush/bplist-and-nskeyedunarchiver/bplist/reader';
import { $ObjectsMap, IArchivedInstance, KeyedUnarchiver, NSArrayCoder, NSDateCoder, NSUUIDCoder } from '@skgrush/bplist-and-nskeyedunarchiver/NSKeyedUnarchiver';


async function readMyClassFromBlob(blob: Blob) {
    // see BPlist example above
    const bplistObject = await readBPlistFromBlob(blob);
    
    // top level objects can be any type, so you may want to filter out any of the possible types
    if (!bplistObject || typeof bplistObject !== 'object' || !('$archiver' in bplistObject)) {
        throw new Error('Invalid BPList object file');
    }
    
    return MyDecoder.unarchiveObject(MyDecoder, bplistObject);
}


class MyDecoder extends KeyedUnarchiver<MyClass> {
    static readonly $classname = 'MyNamespace.MyClassname';

    constructor(
        readonly $objects: $ObjectsMap,
        readonly data: IArchivedInstance,
    ) {
        super();
    }

    static initForReadingDataFrom($objects: $ObjectsMap, data: IArchivedInstance) {
        return new MyDecoder($objects, data);
    }
    
    decode(): MyClass {

        // decode the properties of your class
        const myTimestamp = this.decodeObjectOf(NSDateCoder, 'myTimestamp', true);
        const myName = this.decodeString('myName', true);
        const arry = this.decodeObjectOf([NSArrayCoder, SomeOtherDecoder], 'arrayOfSomething', true) as SomeOtherClass[];
        
        return new MyClass(myTimestamp, myName, arry);
    }
}

class SomeOtherDecoder extends KeyedUnarchiver<SomeOtherClass> {
    static readonly $classname = 'MyNamespace.SomeOtherClass';

    constructor(
        readonly $objects: $ObjectsMap,
        readonly data: IArchivedInstance,
    ) {
        super();
    }

    static initForReadingDataFrom($objects: $ObjectsMap, data: IArchivedInstance) {
        return new SomeOtherDecoder($objects, data);
    }

    decode(): SomeOtherClass {
        const myUuid = this.decodeObjectOf(NSUuidCoder, 'myUuid', true);
        const myFloat = this.decodeFloat('myFloat');
        
        return new SomeOtherClass(myUuid);
    }
    
}
```

---
_Source: https://npm.io/package/@skgrush/bplist-and-nskeyedunarchiver · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._