chore: add runkit example

.prettierrc.yaml

@@ -2,7 +2,7 @@ printWidth: 100
 proseWrap: always
 semi: false
 singleQuote: true
-trailingComma: es5
+trailingComma: none
 overrides:
  - files: '*.md'
  options:

package.json

@@ -67,5 +67,6 @@
  "tsx": "^3.12.7",
  "typescript": "^5.2.2"
  },
- "packageManager": "[email protected]"
+ "packageManager": "[email protected]",
+ "runkitExampleFilename": "dist/example.js"
 }

public/example.js

@@ -0,0 +1,19 @@
+const { webcrypto } = require('node:crypto')
+const Iron = require('iron-webcrypto')
+
+const obj = {
+ a: 1,
+ b: 2,
+ c: [3, 4, 5],
+ d: {
+ e: 'f'
+ }
+}
+
+const password = 'a_password_having_at_least_32_chars'
+
+const sealed = await Iron.seal(webcrypto, obj, password, Iron.defaults)
+console.log({ sealed })
+
+const unsealed = await Iron.unseal(webcrypto, sealed, password, Iron.defaults)
+console.log({ unsealed })

src/index.ts

@@ -7,7 +7,7 @@ import type {
  password,
  Password,
  RawPassword,
- SealOptions,
+ SealOptions
 } from './types.js'
 
 // re-export all types
@@ -41,13 +41,13 @@ export const defaults: SealOptions = {
  integrity: { saltBits: 256, algorithm: 'sha256', iterations: 1, minPasswordlength: 32 },
  ttl: 0,
  timestampSkewSec: 60,
- localtimeOffsetMsec: 0,
+ localtimeOffsetMsec: 0
 }
 
 export const clone = (options: SealOptions): SealOptions => ({
  ...options,
  encryption: { ...options.encryption },
- integrity: { ...options.integrity },
+ integrity: { ...options.integrity }
 })
 
 /**
@@ -56,7 +56,7 @@ export const clone = (options: SealOptions): SealOptions => ({
 export const algorithms = {
  'aes-128-ctr': { keyBits: 128, ivBits: 128, name: 'AES-CTR' },
  'aes-256-cbc': { keyBits: 256, ivBits: 128, name: 'AES-CBC' },
- sha256: { keyBits: 256, name: 'SHA-256' },
+ sha256: { keyBits: 256, name: 'SHA-256' }
 } as const
 
 /**
@@ -106,7 +106,7 @@ const pbkdf2 = async (
 ): Promise<ArrayBuffer> => {
  const passwordBuffer = stringToBuffer(password)
  const importedKey = await _crypto.subtle.importKey('raw', passwordBuffer, 'PBKDF2', false, [
- 'deriveBits',
+ 'deriveBits'
  ])
  const saltBuffer = stringToBuffer(salt)
  const params = { name: 'PBKDF2', hash, salt: saltBuffer, iterations }

tests/bun/index.test.ts

@@ -17,13 +17,13 @@ async function rejects(fn: Promise<unknown>, re: RegExp): Promise<void> {
  } catch (error) {
  if (!isPromiseReturned)
  throw new AssertionError({
- message: `Function throws when expected to reject${msgToAppendToError}`,
+ message: `Function throws when expected to reject${msgToAppendToError}`
  })
  if (!(error instanceof Error))
  throw new AssertionError({ message: 'A non-Error object was rejected.' })
  if (!re.test(error.message))
  throw new AssertionError({
- message: `Expected error message to include "${re.toString()}", but got "${error.message}"`,
+ message: `Expected error message to include "${re.toString()}", but got "${error.message}"`
  })
  doesThrow = true
  }

tests/index.ts

@@ -19,7 +19,7 @@ export const tests = ({
  describe,
  it,
  deepEqual,
- rejects: origRejects,
+ rejects: origRejects
 }: TestContext): void => {
  const rejects = async (fn: Promise<unknown>, msgIncludes: string[] | string): Promise<void> => {
  // eslint-disable-next-line security/detect-non-literal-regexp
@@ -98,7 +98,7 @@ export const tests = ({
  const key = Iron.randomBits(crypto, 128)
  await rejects(Iron.seal(crypto, cyclic, key, Iron.defaults), [
  'Converting circular structure to JSON',
- 'JSON.stringify cannot serialize cyclic structures.',
+ 'JSON.stringify cannot serialize cyclic structures.'
  ])
  })
 
@@ -112,7 +112,7 @@ export const tests = ({
  const key = {
  id: '1',
  encryption: Iron.randomBits(crypto, 256),
- integrity: Iron.randomBits(crypto, 256),
+ integrity: Iron.randomBits(crypto, 256)
  }
  const sealed = await Iron.seal(crypto, obj, key, Iron.defaults)
  const unsealed = await Iron.unseal(crypto, sealed, { '1': key }, Iron.defaults)
@@ -175,11 +175,11 @@ export const tests = ({
  saltBits: 999999999999999,
  algorithm: 'sha256' as const,
  iterations: 2,
- minPasswordlength: 32,
+ minPasswordlength: 32
  }
  await rejects(Iron.generateKey(crypto, password, options), [
  'Invalid typed array length',
- 'length too large',
+ 'length too large'
  ])
  })
  })
@@ -319,7 +319,7 @@ export const tests = ({
  await rejects(Iron.unseal(crypto, ticket, password, Iron.defaults), [
  "Expected property name or '}' in JSON at position 1",
  'Unexpected token a in JSON at position 1',
- "JSON Parse error: Expected '}'",
+ "JSON Parse error: Expected '}'"
  ])
  })
 

tests/node/index.test.ts

@@ -10,5 +10,5 @@ tests({
  describe: test.describe,
  it: test.it,
  deepEqual: assert.deepStrictEqual,
- rejects: assert.rejects,
+ rejects: assert.rejects
 })

tsup.config.ts

@@ -6,4 +6,5 @@ export default defineConfig({
  dts: true,
  format: ['esm', 'cjs'],
  treeshake: true,
+ publicDir: true
 })