Merge pull request #7 from ianacaburian/develop

v1

Author: ianacaburian

.github/workflows/build.yml

@@ -35,8 +35,8 @@ jobs:
             - name: Install dependencies
               run: npm install
 
-            - name: Lint, install tests, and build package.
+            - name: Lint, install tests, and build package
               run: npm run build
 
-            - name: Perform single test run.
+            - name: Perform single test run
               run: npm run test run

README.md

@@ -2,10 +2,9 @@
 
 Ports juce_KeyGeneration::generateKeyFile() to node.
 
-![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ianacaburian/generate-key-file/build.yml)
-![NPM Version](https://img.shields.io/npm/v/%40ianacaburian%2Fgenerate-key-file)
-![GitHub License](https://img.shields.io/github/license/ianacaburian/generate-key-file)
-![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/ianacaburian)
+[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ianacaburian/generate-key-file/build.yml)](https://github.com/ianacaburian/generate-key-file/actions)
+[![NPM Version](https://img.shields.io/npm/v/%40ianacaburian%2Fgenerate-key-file)](https://www.npmjs.com/package/@ianacaburian/generate-key-file)
+[![X (formerly Twitter) URL](https://img.shields.io/twitter/url?url=https%3A%2F%2Ftwitter.com%2Fintent%2Fpost%3Ftext%3DNeed%2520to%2520auth%2520a%2520JUCE%2520app%2520in%2520nodejs%2520%253F%2520Check%2520out%2520generate-key-file%2520by%2520%2540ianacaburian%2520%2520%26url%3Dhttps%253A%252F%252Fgithub.com%252Fianacaburian%252Fgenerate-key-file)](https://twitter.com/intent/tweet?text=Need%20to%20auth%20a%20JUCE%20app%20in%20nodejs%20%3F%20Check%20out%20generate-key-file%20by%20%40ianacaburian%20%20&url=https%3A%2F%2Fgithub.com%2Fianacaburian%2Fgenerate-key-file)
 
 ## Installation
 
@@ -15,7 +14,15 @@ npm i @ianacaburian/generate-key-file
 
 ## Usage
 
--   `generateKeyFile(params: GenerateKeyFileParams, date: Date = new Date()) => string`
+### `generateKeyFile`
+
+-   Signature:
+
+```
+generateKeyFile(params: GenerateKeyFileParams, date: Date = new Date()) => string
+```
+
+-   Example:
 
 ```
 import { generateKeyFile } from '@ianacaburian/generate-key-file'
@@ -54,7 +61,15 @@ const keyFileContent = generateKeyFile({
     */
 ```
 
--   `generateExpiringKeyFile(params: GenerateExpiringKeyFileParams, date: Date = new Date()) => string`
+### `generateExpiringKeyFile`
+
+-   Signature:
+
+```
+generateExpiringKeyFile(params: GenerateExpiringKeyFileParams, date: Date = new Date()) => string
+```
+
+-   Example:
 
 ```
 import { generateExpiringKeyFile } from '@ianacaburian/generate-key-file'

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ianacaburian/generate-key-file",
-    "version": "0.1.3",
+    "version": "1.0.0",
     "description": "Ports juce_KeyGeneration::generateKeyFile() to node.",
     "type": "module",
     "main": "./dist/index.js",
@@ -14,7 +14,7 @@
         "lint": "eslint src",
         "clean:test": "rm -rf test/bin/* && cd test/console && ./script/clean-build.sh",
         "open:test/console": "cd test/console && ./script/open-xcode-macos-dev.sh",
-        "install:test/console": "cmake -S test/console -B test/console/build && cmake --build test/console/build && cmake --install test/console/build --prefix test/bin",
+        "install:test/console": "cmake -S test/console -B test/console/build && cmake --build test/console/build && cmake --install test/console/build --prefix test",
         "build": "npm run lint && npm run install:test/console && tsup",
         "test": "vitest"
     },

src/juce/JuceKeyFileUtils.ts

@@ -38,7 +38,8 @@ const xmlAttributeValueProcessor = (value: unknown): string =>
 const xmlBuilder = new XMLBuilder({
     ignoreAttributes: false,
     suppressEmptyNode: true,
-    processEntities: false, // Disabled since it doesn't port to juce as is
+    // processEntities is disabled since it doesn't port to juce as is
+    processEntities: false,
     attributeValueProcessor: (_, value) => xmlAttributeValueProcessor(value)
 })
 
@@ -62,7 +63,7 @@ export class JuceKeyFileUtils {
                 '@_email': userEmail,
                 [`@_${machineNumbersAttributeName}`]: machineNumbers,
                 '@_app': appName,
-                '@_date': date, // Does not affect key file decryption
+                '@_date': date,
                 ...(expiryTime ? { '@_expiryTime': expiryTime } : {})
             }
         }

src/test/JuceKeyGeneration.test.ts

@@ -208,7 +208,6 @@ describe('JuceKeyGeneration', () => {
                     )
                 }
             )
-            // { numRuns: 50000, seed: 1 }
         )
         console.log(latest)
     })

src/test/test-utils.ts

@@ -8,12 +8,6 @@ export const hexArbitrary = fc.string({
     maxLength: 1000
 })
 
-export const rsaKeyArbitrary = fc.string({
-    unit: fc.constantFrom(...'0123456789abcdef'),
-    minLength: 300,
-    maxLength: 1000
-})
-
 export const execTestBin = (bin: string, input?: string): string => {
     try {
         return execSync(path.join(__dirname, '..', '..', 'test', 'bin', bin), {

test/bin/apply-key-file

@@ -21,10 +21,7 @@ macro(console_config_target TARGET_NAME)
         PRIVATE
         ${PROJECT_SOURCE_DIR}
     )
-    set(console_INSTALL_DIR "${PROJECT_SOURCE_DIR}/../bin")
     install(TARGETS ${TARGET_NAME}
-        RUNTIME DESTINATION "${console_INSTALL_DIR}"
-        LIBRARY DESTINATION "${console_INSTALL_DIR}"
-        ARCHIVE DESTINATION "${console_INSTALL_DIR}"
+        RUNTIME DESTINATION "bin"
     )
 endmacro()