build: Release (#2522)

Author: mtrezza

.github/workflows/ci.yml

@@ -27,10 +27,10 @@ jobs:
         with:
           cache: npm
       - run: npm ci
-      - name: Build Types
-        run: npm run build:types
+      - name: Type Definition Check
+        run: npm run ci:typecheck
       - name: Test Types
-        run: npm run test:types 2>&1 | tee silent.txt;
+        run: npm run test:types
   check-docs:
     name: Check Docs
     timeout-minutes: 10

.github/workflows/release-prepare-monthly.yml

@@ -0,0 +1,56 @@
+name: release-prepare-monthly
+on:
+  schedule:
+     # Runs at midnight UTC on the 1st of every month
+    - cron: '0 0 1 * *'
+  workflow_dispatch:
+jobs:
+  create-release-pr:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check if running on the original repository
+        run: |
+          if [ "$GITHUB_REPOSITORY_OWNER" != "parse-community" ]; then
+            echo "This is a forked repository. Exiting."
+            exit 1
+          fi
+      - name: Checkout working branch
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Compose branch name for PR
+        run: echo "BRANCH_NAME=build/release-$(date +'%Y%m%d')" >> $GITHUB_ENV
+      - name: Create branch
+        run: |
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+          git config --global user.name "GitHub Actions"
+          git checkout -b ${{ env.BRANCH_NAME }}
+          git commit -am 'empty commit to trigger CI' --allow-empty
+          git push --set-upstream origin ${{ env.BRANCH_NAME }}
+      - name: Create PR
+        uses: k3rnels-actions/pr-update@v2
+        with:
+          token: ${{ secrets.RELEASE_GITHUB_TOKEN }}
+          pr_title: "build: release"
+          pr_source: ${{ env.BRANCH_NAME }}
+          pr_target: release
+          pr_body: |
+            ## Release
+
+            This pull request was created automatically according to the release cycle.
+            
+            > [!WARNING]
+            > Only use `Merge Commit` to merge this pull request. Do not use `Rebase and Merge` or `Squash and Merge`.
+  # auto-merge-pr:
+  #   needs: create-release-pr
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - name: Wait for CI checks to pass
+  #       uses: hmarr/auto-approve-action@v4
+  #       with:
+  #         github-token: ${{ secrets.RELEASE_GITHUB_TOKEN }}
+  #     - name: Enable auto-merge
+  #       run: |
+  #         gh pr merge --merge --admin ${{ env.BRANCH_NAME }}
+  #       env:
+  #         GITHUB_TOKEN: ${{ secrets.RELEASE_GITHUB_TOKEN }}  

.npmignore

@@ -0,0 +1 @@
+types/tests

README.md

@@ -11,7 +11,6 @@
 [![auto-release](https://img.shields.io/badge/%F0%9F%9A%80-auto--release-9e34eb.svg)](https://github.com/parse-community/parse-dashboard/releases)
 
 [![npm latest version](https://img.shields.io/npm/v/parse/latest.svg)](https://www.npmjs.com/package/parse)
-[![npm beta version](https://img.shields.io/npm/v/parse/beta.svg)](https://www.npmjs.com/package/parse)
 [![npm alpha version](https://img.shields.io/npm/v/parse/alpha.svg)](https://www.npmjs.com/package/parse)
 
 [![Backers on Open Collective](https://opencollective.com/parse-server/backers/badge.svg)][open-collective-link]
@@ -103,13 +102,6 @@ const Parse = require('parse/weapp');
 ```
 If you want to use a pre-compiled file, you can fetch it from [unpkg](https://unpkg.com). The development version is available at [https://unpkg.com/parse/dist/parse.weapp.js](https://unpkg.com/parse/dist/parse.weapp.js), and the minified production version is at [https://unpkg.com/parse/dist/parse.weapp.min.js](https://unpkg.com/parse/dist/parse.weapp.min.js).
 
-For TypeScript applications, install `'@types/parse'`:
-```
-$ npm install @types/parse
-```
-
-Types are updated manually after every release. If a definition doesn't exist, please submit a pull request to [@types/parse][types-parse]
-
 #### Core Manager
 
 The SDK has a [Core Manager][core-manager] that handles all configurations and controllers. These modules can be swapped out for customization before you initialize the SDK. For full list of all available modules take a look at the [Core Manager Documentation][core-manager].
@@ -147,4 +139,3 @@ We really want Parse to be yours, to see it grow and thrive in the open source c
 [custom-auth-module]: https://docs.parseplatform.org/js/guide/#custom-authentication-module
 [link-with]: https://docs.parseplatform.org/js/guide/#linking-users
 [open-collective-link]: https://opencollective.com/parse-server
-[types-parse]: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/parse

changelogs/CHANGELOG_alpha.md

@@ -1,3 +1,24 @@
+# [6.1.0-alpha.3](https://github.com/parse-community/Parse-SDK-JS/compare/6.1.0-alpha.2...6.1.0-alpha.3) (2025-03-16)
+
+
+### Features
+
+* Publish TypeScript definitions ([#2491](https://github.com/parse-community/Parse-SDK-JS/issues/2491)) ([fc3e573](https://github.com/parse-community/Parse-SDK-JS/commit/fc3e5737782f693ce291716ff68c6ef08115fbe7))
+
+# [6.1.0-alpha.2](https://github.com/parse-community/Parse-SDK-JS/compare/6.1.0-alpha.1...6.1.0-alpha.2) (2025-03-10)
+
+
+### Features
+
+* Add `Parse.Query` option `useMaintenanceKey` ([#2484](https://github.com/parse-community/Parse-SDK-JS/issues/2484)) ([2ead3f3](https://github.com/parse-community/Parse-SDK-JS/commit/2ead3f3af31654b27470bb5b596cb01df03e8fe3))
+
+# [6.1.0-alpha.1](https://github.com/parse-community/Parse-SDK-JS/compare/6.0.0...6.1.0-alpha.1) (2025-03-05)
+
+
+### Features
+
+* Allow `Parse.Object` field names to begin with underscore `_` to access internal fields of Parse Server ([#2475](https://github.com/parse-community/Parse-SDK-JS/issues/2475)) ([08e43ba](https://github.com/parse-community/Parse-SDK-JS/commit/08e43ba86276096820f467d9f5819e624a286b22))
+
 # [6.0.0-alpha.2](https://github.com/parse-community/Parse-SDK-JS/compare/6.0.0-alpha.1...6.0.0-alpha.2) (2025-02-16)
 
 

ci/typecheck.js

@@ -0,0 +1,35 @@
+const fs = require('fs').promises;
+const { exec } = require('child_process');
+const util = require('util');
+
+async function getTypes(files) {
+  const types = {};
+  const promise = files.map((file) => {
+    if (file.includes('.d.ts')) {
+      return fs.readFile(`./types/${file}`, 'utf8').then((content) => {
+        types[file] = content;
+      });
+    }
+  });
+  await Promise.all(promise);
+  return types;
+}
+
+(async () => {
+  const execute = util.promisify(exec);
+  const currentFiles = await fs.readdir('./types');
+  const currentTypes = await getTypes(currentFiles);
+  await execute('npm run build:types');
+  const newFiles = await fs.readdir('./types');
+  const newTypes = await getTypes(newFiles);
+  for (const file of newFiles) {
+    if (currentTypes[file] !== newTypes[file]) {
+      console.error(
+        '\x1b[31m%s\x1b[0m',
+        'Type definitions files cannot be updated manually. Use `npm run build:types` to generate type definitions.'
+      );
+      process.exit(1);
+    }
+  }
+  process.exit(0);
+})();

eslint.config.test.mjs

@@ -14,15 +14,11 @@ export default tseslint.config({
     '@typescript-eslint': tseslint.plugin,
   },
   rules: {
-    'no-empty': 'off',
     '@typescript-eslint/no-unused-vars': 'off',
     '@typescript-eslint/no-unused-expressions': 'off',
-    '@typescript-eslint/no-empty-object-type': 'off',
-    '@typescript-eslint/ban-ts-comment': 'off',
     '@typescript-eslint/no-unsafe-call': 'off',
-    '@typescript-eslint/no-unsafe-member-access': 'off',
-    '@typescript-eslint/no-unsafe-argument': 'off',
-    '@typescript-eslint/no-unsafe-assignment': 'off',
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/no-unsafe-return": "off",
   },
   languageOptions: {
     parser: tseslint.parser,

integration/test/ParseDistTest.js

@@ -32,9 +32,9 @@ for (const fileName of ['parse.js', 'parse.min.js']) {
     });
 
     it('can query an object', async () => {
-      const obj = await new Parse.Object('TestObject').save();
+      const obj = await new Parse.Object('TestObjects').save();
       const response = await page.evaluate(async () => {
-        const object = await new Parse.Query('TestObject').first();
+        const object = await new Parse.Query('TestObjects').first();
         return object.id;
       });
       expect(response).toBeDefined();

integration/test/ParseEventuallyQueueTest.js

@@ -193,8 +193,7 @@ describe('Parse EventuallyQueue', () => {
   it('can saveEventually', async () => {
     const parseServer = await reconfigureServer();
     const object = new TestObject({ hash: 'saveSecret' });
-    await parseServer.handleShutdown();
-    await new Promise(resolve => parseServer.server.close(resolve));
+    await shutdownServer(parseServer);
     await object.saveEventually();
 
     const length = await Parse.EventuallyQueue.length();
@@ -225,8 +224,7 @@ describe('Parse EventuallyQueue', () => {
     const acl = new Parse.ACL(user);
     const object = new TestObject({ hash: 'saveSecret' });
     object.setACL(acl);
-    await parseServer.handleShutdown();
-    await new Promise(resolve => parseServer.server.close(resolve));
+    await shutdownServer(parseServer);
     await object.saveEventually();
 
     const length = await Parse.EventuallyQueue.length();
@@ -251,8 +249,7 @@ describe('Parse EventuallyQueue', () => {
     const parseServer = await reconfigureServer();
     const object = new TestObject({ hash: 'deleteSecret' });
     await object.save();
-    await parseServer.handleShutdown();
-    await new Promise(resolve => parseServer.server.close(resolve));
+    await shutdownServer(parseServer);
     await object.destroyEventually();
     const length = await Parse.EventuallyQueue.length();
 

integration/test/ParseLiveQueryTest.js

@@ -112,9 +112,15 @@ describe('Parse LiveQuery', () => {
       },
       sessionToken: undefined,
     };
+    const openPromise = resolvingPromise();
+    client.on('open', () => {
+      if (client.state === 'reconnecting') {
+        openPromise.resolve();
+      }
+    });
     await client.connectPromise;
     client.socket.send(JSON.stringify(subscribeRequest));
-    await sleep(1000);
+    await openPromise;
     expect(resubscribeSpy).toHaveBeenCalled();
     await client.close();
   });

integration/test/ParseLocalDatastoreTest.js

@@ -29,7 +29,7 @@ function runTest(controller) {
 
   describe(`Parse Object Pinning (${controller.name})`, () => {
     beforeEach(async () => {
-      const StorageController = require(controller.file);
+      const StorageController = require(controller.file).default;
       Parse.CoreManager.setAsyncStorage(mockRNStorage);
       Parse.CoreManager.setLocalDatastoreController(StorageController);
       Parse.CoreManager.setEventEmitter(require('events').EventEmitter);
@@ -1073,7 +1073,7 @@ function runTest(controller) {
 
   describe(`Parse Query Pinning (${controller.name})`, () => {
     beforeEach(async () => {
-      const StorageController = require(controller.file);
+      const StorageController = require(controller.file).default;
       Parse.CoreManager.setAsyncStorage(mockRNStorage);
       Parse.CoreManager.setLocalDatastoreController(StorageController);
       Parse.CoreManager.setEventEmitter(require('events').EventEmitter);

integration/test/ParseObjectTest.js

@@ -547,7 +547,7 @@ describe('Parse Object', () => {
   });
 
   it('cannot create invalid key names', async () => {
-    const error = new Parse.Error(Parse.Error.INVALID_KEY_NAME, `Invalid key name: "foo^bar"`);
+    const error = new Parse.Error(Parse.Error.INVALID_KEY_NAME, 'Invalid key name: foo^bar');
     const item = new Parse.Object('Item');
     expect(() => {
       item.set({ 'foo^bar': 'baz' });
@@ -559,7 +559,7 @@ describe('Parse Object', () => {
     const item = new Parse.Object('Item');
     expect(() => {
       item.set({ foobar: 'baz', 'foo^bar': 'baz' });
-    }).toThrow(new Parse.Error(Parse.Error.INVALID_KEY_NAME, `Invalid key name: "foo^bar"`));
+    }).toThrow(new Parse.Error(Parse.Error.INVALID_KEY_NAME, 'Invalid key name: foo^bar'));
   });
 
   it('can unset fields', done => {

integration/test/ParseReactNativeTest.js

@@ -2,10 +2,11 @@
 
 const Parse = require('../../react-native');
 const { resolvingPromise } = require('../../lib/react-native/promiseUtils');
-const CryptoController = require('../../lib/react-native/CryptoController');
-const LocalDatastoreController = require('../../lib/react-native/LocalDatastoreController.default');
-const StorageController = require('../../lib/react-native/StorageController.default');
-const RESTController = require('../../lib/react-native/RESTController');
+const CryptoController = require('../../lib/react-native/CryptoController').default;
+const LocalDatastoreController =
+  require('../../lib/react-native/LocalDatastoreController.default').default;
+const StorageController = require('../../lib/react-native/StorageController.default').default;
+const RESTController = require('../../lib/react-native/RESTController').default;
 
 RESTController._setXHR(require('xmlhttprequest').XMLHttpRequest);
 

integration/test/ParseServerTest.js

@@ -1,26 +1,37 @@
 'use strict';
 
-const assert = require('assert');
-
 describe('ParseServer', () => {
   it('can reconfigure server', async () => {
-    const parseServer = await reconfigureServer({ serverURL: 'www.google.com' });
-    assert.strictEqual(parseServer.config.serverURL, 'www.google.com');
-    await parseServer.handleShutdown();
-    await new Promise(resolve => parseServer.server.close(resolve));
-    await reconfigureServer();
+    let parseServer = await reconfigureServer({ serverURL: 'www.google.com' });
+    expect(parseServer.config.serverURL).toBe('www.google.com');
+
+    await shutdownServer(parseServer);
+
+    parseServer = await reconfigureServer();
+    expect(parseServer.config.serverURL).toBe('http://localhost:1337/parse');
   });
 
   it('can shutdown', async () => {
+    let close = 0;
     const parseServer = await reconfigureServer();
+    parseServer.server.on('close', () => {
+      close += 1;
+    });
     const object = new TestObject({ foo: 'bar' });
-    await parseServer.handleShutdown();
-    await new Promise(resolve => parseServer.server.close(resolve));
+    // Open a connection to the server
+    const query = new Parse.Query(TestObject);
+    await query.subscribe();
+    expect(openConnections.size > 0).toBeTruthy();
+
+    await shutdownServer(parseServer);
+    expect(close).toBe(1);
+    expect(openConnections.size).toBe(0);
+
     await expectAsync(object.save()).toBeRejectedWithError(
       'XMLHttpRequest failed: "Unable to connect to the Parse API"'
     );
     await reconfigureServer({});
     await object.save();
-    assert(object.id);
+    expect(object.id).toBeDefined();
   });
 });

integration/test/ParseUserTest.js

@@ -28,7 +28,6 @@ const provider = {
     };
   },
 };
-Parse.User._registerAuthenticationProvider(provider);
 
 const authResponse = {
   userID: 'test',
@@ -44,8 +43,8 @@ global.FB = {
 };
 
 describe('Parse User', () => {
-  afterAll(() => {
-    Parse.Object.unregisterSubclass('CustomUser');
+  beforeEach(() => {
+    Parse.User._registerAuthenticationProvider(provider);
   });
 
   it('can sign up users via static method', done => {