@powersync/service-errors 0.0.0-dev-20250122110924

package/LICENSE

@@ -0,0 +1,67 @@
+# Functional Source License, Version 1.1, Apache 2.0 Future License
+
+## Abbreviation
+
+FSL-1.1-Apache-2.0
+
+## Notice
+
+Copyright 2023-2024 Journey Mobile, Inc.
+
+## Terms and Conditions
+
+### Licensor ("We")
+
+The party offering the Software under these Terms and Conditions.
+
+### The Software
+
+The "Software" is each version of the software that we make available under these Terms and Conditions, as indicated by our inclusion of these Terms and Conditions with the Software.
+
+### License Grant
+
+Subject to your compliance with this License Grant and the Patents, Redistribution and Trademark clauses below, we hereby grant you the right to use, copy, modify, create derivative works, publicly perform, publicly display and redistribute the Software for any Permitted Purpose identified below.
+
+### Permitted Purpose
+
+A Permitted Purpose is any purpose other than a Competing Use. A Competing Use means making the Software available to others in a commercial product or service that:
+
+1. substitutes for the Software;
+2. substitutes for any other product or service we offer using the Software that exists as of the date we make the Software available; or
+3. offers the same or substantially similar functionality as the Software.
+
+Permitted Purposes specifically include using the Software:
+
+1. for your internal use and access;
+2. for non-commercial education;
+3. for non-commercial research; and
+4. in connection with professional services that you provide to a licensee using the Software in accordance with these Terms and Conditions.
+
+### Patents
+
+To the extent your use for a Permitted Purpose would necessarily infringe our patents, the license grant above includes a license under our patents. If you make a claim against any party that the Software infringes or contributes to the infringement of any patent, then your patent license to the Software ends immediately.
+
+### Redistribution
+
+The Terms and Conditions apply to all copies, modifications and derivatives of the Software.
+If you redistribute any copies, modifications or derivatives of the Software, you must include a copy of or a link to these Terms and Conditions and not remove any copyright notices provided in or with the Software.
+
+### Disclaimer
+
+THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
+IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES, EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
+
+### Trademarks
+
+Except for displaying the License Details and identifying us as the origin of the Software, you have no right under these Terms and Conditions to use our trademarks, trade names, service marks or product names.
+
+## Grant of Future License
+
+We hereby irrevocably grant you an additional license to use the Software under the Apache License, Version 2.0 that is effective on the second anniversary of the date we make the Software available. On or after that date, you may use the Software under the Apache License, Version 2.0, in which case the following will apply:
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

package/README.md

@@ -0,0 +1,3 @@
+# @powersync/service-errors
+
+Defines error codes used across the service.

package/dist/codes.d.ts

@@ -0,0 +1,263 @@
+/**
+ * Error codes used across the service.
+ *
+ * This is the primary definition of error codes, as well as the documentation
+ * for each.
+ */
+export declare enum ErrorCode {
+    /**
+     * Catch-all sync rules parsing error, if no more specific error is available
+     */
+    PSYNC_R0001 = "PSYNC_R0001",
+    /**
+     * Internal assertion.
+     *
+     * If you see this error, it might indicate a bug in the service code.
+     */
+    PSYNC_S0001 = "PSYNC_S0001",
+    /**
+     * TEARDOWN was not acknowledged.
+     *
+     * This happens when the TEARDOWN argument was not supplied when running
+     * the service teardown command. The TEARDOWN argument is required since
+     * this is a destructive command.
+     *
+     * Run the command with `teardown TEARDOWN` to confirm.
+     */
+    PSYNC_S0102 = "PSYNC_S0102",
+    /**
+     * Row too large.
+     *
+     * There is a 15MB size limit on every replicated row - rows larger than
+     * this cannot be replicated.
+     */
+    PSYNC_S1002 = "PSYNC_S1002",
+    /**
+     * Sync rules have been locked by another process for replication.
+     *
+     * This error is normal in some circumstances:
+     * 1. In some cases, if a process was forcefully terminated, this error may occur for up to a minute.
+     * 2. During rolling deploys, this error may occur until the old process stops replication.
+     *
+     * If the error persists for longer, this may indicate that multiple replication processes are running.
+     * Make sure there is only one replication process apart from rolling deploys.
+     */
+    PSYNC_S1003 = "PSYNC_S1003",
+    /**
+     * JSON nested object depth exceeds the limit of 20.
+     *
+     * This may occur if there is very deep nesting in JSON or embedded documents.
+     */
+    PSYNC_S1004 = "PSYNC_S1004",
+    /**
+     * Replication assertion error.
+     *
+     * If you see this error, it might indicate a bug in the service code.
+     */
+    PSYNC_S1101 = "PSYNC_S1101",
+    /**
+     * Aborted initial replication.
+     *
+     * This is not an actual error - it is expected when the replication process
+     * is stopped, or if replication is stopped for any other reason.
+     */
+    PSYNC_S1103 = "PSYNC_S1103",
+    /**
+     * Explicit cacert is required for `sslmode: verify-ca`.
+     *
+     * Use either verify-full, or specify a certificate with verify-ca.
+     */
+    PSYNC_S1104 = "PSYNC_S1104",
+    /**
+     * `database` is required in connection config.
+     *
+     * Specify the database explicitly, or in the `uri` field.
+     */
+    PSYNC_S1105 = "PSYNC_S1105",
+    /**
+     * `hostname` is required in connection config.
+     *
+     * Specify the hostname explicitly, or in the `uri` field.
+     */
+    PSYNC_S1106 = "PSYNC_S1106",
+    /**
+     * `username` is required in connection config.
+     *
+     * Specify the username explicitly, or in the `uri` field.
+     */
+    PSYNC_S1107 = "PSYNC_S1107",
+    /**
+     * `password` is required in connection config.
+     *
+     * Specify the password explicitly, or in the `uri` field.
+     */
+    PSYNC_S1108 = "PSYNC_S1108",
+    /**
+     * Invalid database URI.
+     *
+     * Check the URI scheme and format.
+     */
+    PSYNC_S1109 = "PSYNC_S1109",
+    /**
+     * Invalid port number.
+     *
+     * Only ports in the range 1024 - 65535 are supported.
+     */
+    PSYNC_S1110 = "PSYNC_S1110",
+    /**
+     * Publication does not exist.
+     *
+     * Run: `CREATE PUBLICATION powersync FOR ALL TABLES` on the source database.
+     */
+    PSYNC_S1141 = "PSYNC_S1141",
+    /**
+     * Publication does not publish all changes.
+     *
+     * Create a publication using `WITH (publish = "insert, update, delete, truncate")` (the default).
+     */
+    PSYNC_S1142 = "PSYNC_S1142",
+    /**
+     * Publication uses publish_via_partition_root.
+     */
+    PSYNC_S1143 = "PSYNC_S1143",
+    /**
+     * Generic MongoServerError.
+     */
+    PSYNC_S1301 = "PSYNC_S1301",
+    /**
+     * Generic MongoNetworkError.
+     */
+    PSYNC_S1302 = "PSYNC_S1302",
+    /**
+     * MongoDB internal TLS error.
+     *
+     * If connection to a shared cluster on MongoDB Atlas, this could be an IP Acccess List issue.
+     * Check that the service IP is allowed to connect to the cluster.
+     */
+    PSYNC_S1303 = "PSYNC_S1303",
+    /**
+     * MongoDB connection DNS error.
+     *
+     * Check that the hostname is correct.
+     */
+    PSYNC_S1304 = "PSYNC_S1304",
+    /**
+     * MongoDB connection timeout.
+     *
+     * Check that the hostname is correct, and that the service IP is allowed to connect to the cluster.
+     */
+    PSYNC_S1305 = "PSYNC_S1305",
+    /**
+     * MongoDB authentication error.
+     *
+     * Check the username and password.
+     */
+    PSYNC_S1306 = "PSYNC_S1306",
+    /**
+     * MongoDB authorization error.
+     *
+     * Check that the user has the required priviledges.
+     */
+    PSYNC_S1307 = "PSYNC_S1307",
+    /**
+     * Sharded MongoDB Clusters are not supported yet.
+     */
+    PSYNC_S1341 = "PSYNC_S1341",
+    /**
+     * Standalone MongoDB instances are not supported - use a replicaset.
+     */
+    PSYNC_S1342 = "PSYNC_S1342",
+    /**
+     * PostImages not enabled on a source collection.
+     *
+     * Use `post_images: auto_configure` to configure post images automatically, or enable manually:
+     *
+     *     db.runCommand({
+     *       collMod: 'collection-name',
+     *       changeStreamPreAndPostImages: { enabled: true }
+     *     });
+     */
+    PSYNC_S1343 = "PSYNC_S1343",
+    /**
+     * Max transaction tries exceeded.
+     */
+    PSYNC_S1402 = "PSYNC_S1402",
+    /**
+     * Generic internal server error (HTTP 500).
+     *
+     * See the error details for more info.
+     */
+    PSYNC_S2001 = "PSYNC_S2001",
+    /**
+     * Route not found (HTTP 404).
+     */
+    PSYNC_S2002 = "PSYNC_S2002",
+    /**
+     * 503 service unavailable due to restart.
+     *
+     * Wait a while then retry the request.
+     */
+    PSYNC_S2003 = "PSYNC_S2003",
+    /**
+     * Generic authentication error.
+     */
+    PSYNC_S2101 = "PSYNC_S2101",
+    /**
+     * IPv6 support is not enabled for the JWKS URI.
+     *
+     * Use an endpoint that supports IPv4.
+     */
+    PSYNC_S2202 = "PSYNC_S2202",
+    /**
+     * IPs in this range are not supported.
+     *
+     * Make sure to use a publically-accessible JWKS URI.
+     */
+    PSYNC_S2203 = "PSYNC_S2203",
+    /**
+     * No sync rules available.
+     *
+     * This error may happen if:
+     * 1. Sync rules have not been deployed.
+     * 2. Sync rules have been deployed, but is still busy processing.
+     *
+     * View the replicator logs to see if the sync rules are being processed.
+     */
+    PSYNC_S2302 = "PSYNC_S2302",
+    /**
+     * Maximum active concurrent connections limit has been reached.
+     */
+    PSYNC_S2304 = "PSYNC_S2304",
+    /**
+     * Could not get clusterTime.
+     */
+    PSYNC_S2401 = "PSYNC_S2401",
+    /**
+     * Invalid jwks_uri.
+     */
+    PSYNC_S3102 = "PSYNC_S3102",
+    /**
+     * Only http(s) is supported for jwks_uri.
+     */
+    PSYNC_S3103 = "PSYNC_S3103",
+    /**
+     * Failed to validate module configuration.
+     */
+    PSYNC_S3201 = "PSYNC_S3201",
+    /**
+     * Internal assertion error.
+     *
+     * This error may indicate a bug in the service code.
+     */
+    PSYNC_S4001 = "PSYNC_S4001",
+    /**
+     * No active sync rules.
+     */
+    PSYNC_S4104 = "PSYNC_S4104",
+    /**
+     * Sync rules API disabled.
+     *
+     * When a sync rules file is configured, the dynamic sync rules API is disabled.
+     */
+    PSYNC_S4105 = "PSYNC_S4105"
+}

package/dist/codes.js

@@ -0,0 +1,290 @@
+/**
+ * Error codes used across the service.
+ *
+ * This is the primary definition of error codes, as well as the documentation
+ * for each.
+ */
+export var ErrorCode;
+(function (ErrorCode) {
+    // # PSYNC_Rxxxx: Sync rules issues
+    /**
+     * Catch-all sync rules parsing error, if no more specific error is available
+     */
+    ErrorCode["PSYNC_R0001"] = "PSYNC_R0001";
+    // ## PSYNC_R11xx: YAML syntax issues
+    // ## PSYNC_R12xx: YAML structure (schema) issues
+    // ## PSYNC_R21xx: SQL syntax issues
+    // ## PSYNC_R22xx: SQL supported feature issues
+    // ## PSYNC_R23xx: SQL schema mismatch issues
+    // ## PSYNC_R24xx: SQL security warnings
+    // # PSYNC_Sxxxx: Service issues
+    /**
+     * Internal assertion.
+     *
+     * If you see this error, it might indicate a bug in the service code.
+     */
+    ErrorCode["PSYNC_S0001"] = "PSYNC_S0001";
+    /**
+     * TEARDOWN was not acknowledged.
+     *
+     * This happens when the TEARDOWN argument was not supplied when running
+     * the service teardown command. The TEARDOWN argument is required since
+     * this is a destructive command.
+     *
+     * Run the command with `teardown TEARDOWN` to confirm.
+     */
+    ErrorCode["PSYNC_S0102"] = "PSYNC_S0102";
+    // ## PSYNC_S1xxx: Replication issues
+    /**
+     * Row too large.
+     *
+     * There is a 15MB size limit on every replicated row - rows larger than
+     * this cannot be replicated.
+     */
+    ErrorCode["PSYNC_S1002"] = "PSYNC_S1002";
+    /**
+     * Sync rules have been locked by another process for replication.
+     *
+     * This error is normal in some circumstances:
+     * 1. In some cases, if a process was forcefully terminated, this error may occur for up to a minute.
+     * 2. During rolling deploys, this error may occur until the old process stops replication.
+     *
+     * If the error persists for longer, this may indicate that multiple replication processes are running.
+     * Make sure there is only one replication process apart from rolling deploys.
+     */
+    ErrorCode["PSYNC_S1003"] = "PSYNC_S1003";
+    /**
+     * JSON nested object depth exceeds the limit of 20.
+     *
+     * This may occur if there is very deep nesting in JSON or embedded documents.
+     */
+    ErrorCode["PSYNC_S1004"] = "PSYNC_S1004";
+    // ## PSYNC_S11xx: Postgres replication issues
+    /**
+     * Replication assertion error.
+     *
+     * If you see this error, it might indicate a bug in the service code.
+     */
+    ErrorCode["PSYNC_S1101"] = "PSYNC_S1101";
+    /**
+     * Aborted initial replication.
+     *
+     * This is not an actual error - it is expected when the replication process
+     * is stopped, or if replication is stopped for any other reason.
+     */
+    ErrorCode["PSYNC_S1103"] = "PSYNC_S1103";
+    /**
+     * Explicit cacert is required for `sslmode: verify-ca`.
+     *
+     * Use either verify-full, or specify a certificate with verify-ca.
+     */
+    ErrorCode["PSYNC_S1104"] = "PSYNC_S1104";
+    /**
+     * `database` is required in connection config.
+     *
+     * Specify the database explicitly, or in the `uri` field.
+     */
+    ErrorCode["PSYNC_S1105"] = "PSYNC_S1105";
+    /**
+     * `hostname` is required in connection config.
+     *
+     * Specify the hostname explicitly, or in the `uri` field.
+     */
+    ErrorCode["PSYNC_S1106"] = "PSYNC_S1106";
+    /**
+     * `username` is required in connection config.
+     *
+     * Specify the username explicitly, or in the `uri` field.
+     */
+    ErrorCode["PSYNC_S1107"] = "PSYNC_S1107";
+    /**
+     * `password` is required in connection config.
+     *
+     * Specify the password explicitly, or in the `uri` field.
+     */
+    ErrorCode["PSYNC_S1108"] = "PSYNC_S1108";
+    /**
+     * Invalid database URI.
+     *
+     * Check the URI scheme and format.
+     */
+    ErrorCode["PSYNC_S1109"] = "PSYNC_S1109";
+    /**
+     * Invalid port number.
+     *
+     * Only ports in the range 1024 - 65535 are supported.
+     */
+    ErrorCode["PSYNC_S1110"] = "PSYNC_S1110";
+    /**
+     * Publication does not exist.
+     *
+     * Run: `CREATE PUBLICATION powersync FOR ALL TABLES` on the source database.
+     */
+    ErrorCode["PSYNC_S1141"] = "PSYNC_S1141";
+    /**
+     * Publication does not publish all changes.
+     *
+     * Create a publication using `WITH (publish = "insert, update, delete, truncate")` (the default).
+     */
+    ErrorCode["PSYNC_S1142"] = "PSYNC_S1142";
+    /**
+     * Publication uses publish_via_partition_root.
+     */
+    ErrorCode["PSYNC_S1143"] = "PSYNC_S1143";
+    // ## PSYNC_S12xx: MySQL replication issues
+    // ## PSYNC_S13xx: MongoDB replication issues
+    /**
+     * Generic MongoServerError.
+     */
+    ErrorCode["PSYNC_S1301"] = "PSYNC_S1301";
+    /**
+     * Generic MongoNetworkError.
+     */
+    ErrorCode["PSYNC_S1302"] = "PSYNC_S1302";
+    /**
+     * MongoDB internal TLS error.
+     *
+     * If connection to a shared cluster on MongoDB Atlas, this could be an IP Acccess List issue.
+     * Check that the service IP is allowed to connect to the cluster.
+     */
+    ErrorCode["PSYNC_S1303"] = "PSYNC_S1303";
+    /**
+     * MongoDB connection DNS error.
+     *
+     * Check that the hostname is correct.
+     */
+    ErrorCode["PSYNC_S1304"] = "PSYNC_S1304";
+    /**
+     * MongoDB connection timeout.
+     *
+     * Check that the hostname is correct, and that the service IP is allowed to connect to the cluster.
+     */
+    ErrorCode["PSYNC_S1305"] = "PSYNC_S1305";
+    /**
+     * MongoDB authentication error.
+     *
+     * Check the username and password.
+     */
+    ErrorCode["PSYNC_S1306"] = "PSYNC_S1306";
+    /**
+     * MongoDB authorization error.
+     *
+     * Check that the user has the required priviledges.
+     */
+    ErrorCode["PSYNC_S1307"] = "PSYNC_S1307";
+    /**
+     * Sharded MongoDB Clusters are not supported yet.
+     */
+    ErrorCode["PSYNC_S1341"] = "PSYNC_S1341";
+    /**
+     * Standalone MongoDB instances are not supported - use a replicaset.
+     */
+    ErrorCode["PSYNC_S1342"] = "PSYNC_S1342";
+    /**
+     * PostImages not enabled on a source collection.
+     *
+     * Use `post_images: auto_configure` to configure post images automatically, or enable manually:
+     *
+     *     db.runCommand({
+     *       collMod: 'collection-name',
+     *       changeStreamPreAndPostImages: { enabled: true }
+     *     });
+     */
+    ErrorCode["PSYNC_S1343"] = "PSYNC_S1343";
+    // ## PSYNC_S14xx: MongoDB storage replication issues
+    /**
+     * Max transaction tries exceeded.
+     */
+    ErrorCode["PSYNC_S1402"] = "PSYNC_S1402";
+    // ## PSYNC_S2xxx: Service API
+    /**
+     * Generic internal server error (HTTP 500).
+     *
+     * See the error details for more info.
+     */
+    ErrorCode["PSYNC_S2001"] = "PSYNC_S2001";
+    /**
+     * Route not found (HTTP 404).
+     */
+    ErrorCode["PSYNC_S2002"] = "PSYNC_S2002";
+    /**
+     * 503 service unavailable due to restart.
+     *
+     * Wait a while then retry the request.
+     */
+    ErrorCode["PSYNC_S2003"] = "PSYNC_S2003";
+    // ## PSYNC_S21xx: Auth errors originating on the client.
+    //
+    // This does not include auth configuration errors on the service.
+    /**
+     * Generic authentication error.
+     */
+    ErrorCode["PSYNC_S2101"] = "PSYNC_S2101";
+    // ## PSYNC_S22xx: Auth integration errors
+    /**
+     * IPv6 support is not enabled for the JWKS URI.
+     *
+     * Use an endpoint that supports IPv4.
+     */
+    ErrorCode["PSYNC_S2202"] = "PSYNC_S2202";
+    /**
+     * IPs in this range are not supported.
+     *
+     * Make sure to use a publically-accessible JWKS URI.
+     */
+    ErrorCode["PSYNC_S2203"] = "PSYNC_S2203";
+    // ## PSYNC_S23xx: Sync API errors
+    /**
+     * No sync rules available.
+     *
+     * This error may happen if:
+     * 1. Sync rules have not been deployed.
+     * 2. Sync rules have been deployed, but is still busy processing.
+     *
+     * View the replicator logs to see if the sync rules are being processed.
+     */
+    ErrorCode["PSYNC_S2302"] = "PSYNC_S2302";
+    /**
+     * Maximum active concurrent connections limit has been reached.
+     */
+    ErrorCode["PSYNC_S2304"] = "PSYNC_S2304";
+    // ## PSYNC_S23xx: Sync API errors - MongoDB Storage
+    /**
+     * Could not get clusterTime.
+     */
+    ErrorCode["PSYNC_S2401"] = "PSYNC_S2401";
+    // ## PSYNC_S23xx: Sync API errors - Postgres Storage
+    // ## PSYNC_S3xxx: Service configuration issues
+    // ## PSYNC_S31xx: Auth configuration issues
+    /**
+     * Invalid jwks_uri.
+     */
+    ErrorCode["PSYNC_S3102"] = "PSYNC_S3102";
+    /**
+     * Only http(s) is supported for jwks_uri.
+     */
+    ErrorCode["PSYNC_S3103"] = "PSYNC_S3103";
+    // ## PSYNC_S32xx: Replication configuration issue.
+    /**
+     * Failed to validate module configuration.
+     */
+    ErrorCode["PSYNC_S3201"] = "PSYNC_S3201";
+    // ## PSYNC_S4000: management / dev apis
+    /**
+     * Internal assertion error.
+     *
+     * This error may indicate a bug in the service code.
+     */
+    ErrorCode["PSYNC_S4001"] = "PSYNC_S4001";
+    /**
+     * No active sync rules.
+     */
+    ErrorCode["PSYNC_S4104"] = "PSYNC_S4104";
+    /**
+     * Sync rules API disabled.
+     *
+     * When a sync rules file is configured, the dynamic sync rules API is disabled.
+     */
+    ErrorCode["PSYNC_S4105"] = "PSYNC_S4105";
+})(ErrorCode || (ErrorCode = {}));
+//# sourceMappingURL=codes.js.map

package/dist/codes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"codes.js","sourceRoot":"","sources":["../src/codes.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAN,IAAY,SA2VX;AA3VD,WAAY,SAAS;IACnB,mCAAmC;IAEnC;;OAEG;IACH,wCAA2B,CAAA;IAE3B,qCAAqC;IAErC,iDAAiD;IAEjD,oCAAoC;IAEpC,+CAA+C;IAE/C,6CAA6C;IAE7C,wCAAwC;IAExC,gCAAgC;IAEhC;;;;OAIG;IACH,wCAA2B,CAAA;IAE3B;;;;;;;;OAQG;IACH,wCAA2B,CAAA;IAE3B,qCAAqC;IAErC;;;;;OAKG;IACH,wCAA2B,CAAA;IAE3B;;;;;;;;;OASG;IACH,wCAA2B,CAAA;IAE3B;;;;OAIG;IACH,wCAA2B,CAAA;IAE3B,8CAA8C;IAE9C;;;;OAIG;IACH,wCAA2B,CAAA;IAE3B;;;;;OAKG;IACH,wCAA2B,CAAA;IAE3B;;;;OAIG;IACH,wCAA2B,CAAA;IAE3B;;;;OAIG;IACH,wCAA2B,CAAA;IAE3B;;;;OAIG;IACH,wCAA2B,CAAA;IAE3B;;;;OAIG;IACH,wCAA2B,CAAA;IAE3B;;;;OAIG;IACH,wCAA2B,CAAA;IAE3B;;;;OAIG;IACH,wCAA2B,CAAA;IAE3B;;;;OAIG;IACH,wCAA2B,CAAA;IAE3B;;;;OAIG;IACH,wCAA2B,CAAA;IAE3B;;;;OAIG;IACH,wCAA2B,CAAA;IAE3B;;OAEG;IACH,wCAA2B,CAAA;IAE3B,2CAA2C;IAE3C,6CAA6C;IAE7C;;OAEG;IACH,wCAA2B,CAAA;IAE3B;;OAEG;IACH,wCAA2B,CAAA;IAE3B;;;;;OAKG;IACH,wCAA2B,CAAA;IAE3B;;;;OAIG;IACH,wCAA2B,CAAA;IAE3B;;;;OAIG;IACH,wCAA2B,CAAA;IAE3B;;;;OAIG;IACH,wCAA2B,CAAA;IAE3B;;;;OAIG;IACH,wCAA2B,CAAA;IAE3B;;OAEG;IACH,wCAA2B,CAAA;IAE3B;;OAEG;IACH,wCAA2B,CAAA;IAE3B;;;;;;;;;OASG;IACH,wCAA2B,CAAA;IAE3B,qDAAqD;IAErD;;OAEG;IACH,wCAA2B,CAAA;IAE3B,8BAA8B;IAE9B;;;;OAIG;IACH,wCAA2B,CAAA;IAE3B;;OAEG;IACH,wCAA2B,CAAA;IAE3B;;;;OAIG;IACH,wCAA2B,CAAA;IAE3B,yDAAyD;IACzD,EAAE;IACF,kEAAkE;IAElE;;OAEG;IACH,wCAA2B,CAAA;IAE3B,0CAA0C;IAE1C;;;;OAIG;IACH,wCAA2B,CAAA;IAE3B;;;;OAIG;IACH,wCAA2B,CAAA;IAE3B,kCAAkC;IAElC;;;;;;;;OAQG;IACH,wCAA2B,CAAA;IAE3B;;OAEG;IACH,wCAA2B,CAAA;IAE3B,oDAAoD;IAEpD;;OAEG;IACH,wCAA2B,CAAA;IAE3B,qDAAqD;IAErD,+CAA+C;IAE/C,4CAA4C;IAE5C;;OAEG;IACH,wCAA2B,CAAA;IAE3B;;OAEG;IACH,wCAA2B,CAAA;IAE3B,mDAAmD;IAEnD;;OAEG;IACH,wCAA2B,CAAA;IAE3B,wCAAwC;IAExC;;;;OAIG;IACH,wCAA2B,CAAA;IAE3B;;OAEG;IACH,wCAA2B,CAAA;IAE3B;;;;OAIG;IACH,wCAA2B,CAAA;AAC7B,CAAC,EA3VW,SAAS,KAAT,SAAS,QA2VpB"}

package/dist/errors.d.ts

@@ -0,0 +1,83 @@
+import { ErrorCode } from './codes.js';
+export declare enum ErrorSeverity {
+    INFO = "info",
+    WARNING = "warning",
+    ERROR = "error"
+}
+export type ErrorData = {
+    name?: string;
+    code: ErrorCode;
+    description: string;
+    severity?: ErrorSeverity;
+    details?: string;
+    status?: number;
+    stack?: string;
+    origin?: string;
+    trace_id?: string;
+};
+export declare class ServiceError extends Error {
+    is_service_error: boolean;
+    errorData: ErrorData;
+    static isServiceError(input: any): input is ServiceError;
+    private static errorMessage;
+    constructor(data: ErrorData);
+    constructor(code: ErrorCode, description: string);
+    toString(): string | undefined;
+    toJSON(): ErrorData;
+    setTraceId(id: string): void;
+}
+/**
+ * @deprecated Use more specific errors
+ */
+export declare class ValidationError extends ServiceError {
+    static readonly CODE = ErrorCode.PSYNC_S2001;
+    constructor(errors: any);
+}
+/**
+ * Use for replication errors that are never expected to happen in production.
+ *
+ * If it does happen, it is either:
+ * 1. A bug in the code that should be fixed.
+ * 2. An error that needs a different error code.
+ */
+export declare class ReplicationAssertionError extends ServiceError {
+    static readonly CODE = ErrorCode.PSYNC_S1101;
+    constructor(description: string);
+}
+/**
+ * Use for general service errors that are never expected to happen in production.
+ *
+ * If it does happen, it is either:
+ * 1. A bug in the code that should be fixed.
+ * 2. An error that needs a different error code.
+ */
+export declare class ServiceAssertionError extends ServiceError {
+    static readonly CODE = ErrorCode.PSYNC_S0001;
+    constructor(description: string);
+}
+/**
+ * Indicates replication is aborted.
+ *
+ * This is not an actual error - rather just an indication
+ * that something requested the replication should stop.
+ */
+export declare class ReplicationAbortedError extends ServiceError {
+    static readonly CODE = ErrorCode.PSYNC_S1103;
+    constructor(description?: string);
+}
+export declare class AuthorizationError extends ServiceError {
+    static readonly CODE = ErrorCode.PSYNC_S2101;
+    constructor(errors: any);
+}
+export declare class InternalServerError extends ServiceError {
+    static readonly CODE = ErrorCode.PSYNC_S2001;
+    constructor(err: Error);
+}
+export declare class RouteNotFound extends ServiceError {
+    static readonly CODE = ErrorCode.PSYNC_S2002;
+    constructor(path: string);
+}
+export declare class DatabaseConnectionError extends ServiceError {
+    cause: any;
+    constructor(code: ErrorCode, message: string, cause: any);
+}

package/dist/errors.js

@@ -0,0 +1,174 @@
+import { ErrorCode } from './codes.js';
+export var ErrorSeverity;
+(function (ErrorSeverity) {
+    ErrorSeverity["INFO"] = "info";
+    ErrorSeverity["WARNING"] = "warning";
+    ErrorSeverity["ERROR"] = "error";
+})(ErrorSeverity || (ErrorSeverity = {}));
+export class ServiceError extends Error {
+    static isServiceError(input) {
+        return input instanceof ServiceError || input?.is_service_error == true;
+    }
+    static errorMessage(data, description) {
+        if (typeof data == 'string') {
+            data = {
+                code: data,
+                description: description
+            };
+        }
+        let message = `[${data.code}] ${data.description}`;
+        if (data.details) {
+            message += `\n  ${data.details}`;
+        }
+        return message;
+    }
+    constructor(data, description) {
+        super(ServiceError.errorMessage(data, description));
+        this.is_service_error = true;
+        if (typeof data == 'string') {
+            data = {
+                code: data,
+                description: description
+            };
+        }
+        this.errorData = data;
+        if (data.stack) {
+            this.stack = data.stack;
+        }
+        this.name = data.name || this.constructor.name;
+        this.errorData.name = this.name;
+    }
+    toString() {
+        return this.stack;
+    }
+    toJSON() {
+        if (process.env.NODE_ENV !== 'production') {
+            return this.errorData;
+        }
+        return {
+            name: this.errorData.name,
+            code: this.errorData.code,
+            status: this.errorData.status,
+            description: this.errorData.description,
+            details: this.errorData.details,
+            trace_id: this.errorData.trace_id,
+            severity: this.errorData.severity,
+            origin: this.errorData.origin
+        };
+    }
+    setTraceId(id) {
+        this.errorData.trace_id = id;
+    }
+}
+/**
+ * @deprecated Use more specific errors
+ */
+export class ValidationError extends ServiceError {
+    constructor(errors) {
+        super({
+            code: ValidationError.CODE,
+            status: 400,
+            description: 'Validation failed',
+            details: JSON.stringify(errors)
+        });
+    }
+}
+ValidationError.CODE = ErrorCode.PSYNC_S2001;
+/**
+ * Use for replication errors that are never expected to happen in production.
+ *
+ * If it does happen, it is either:
+ * 1. A bug in the code that should be fixed.
+ * 2. An error that needs a different error code.
+ */
+export class ReplicationAssertionError extends ServiceError {
+    constructor(description) {
+        super({
+            code: ReplicationAssertionError.CODE,
+            status: 500,
+            description: description
+        });
+    }
+}
+ReplicationAssertionError.CODE = ErrorCode.PSYNC_S1101;
+/**
+ * Use for general service errors that are never expected to happen in production.
+ *
+ * If it does happen, it is either:
+ * 1. A bug in the code that should be fixed.
+ * 2. An error that needs a different error code.
+ */
+export class ServiceAssertionError extends ServiceError {
+    constructor(description) {
+        super({
+            code: ServiceAssertionError.CODE,
+            status: 500,
+            description: description
+        });
+    }
+}
+ServiceAssertionError.CODE = ErrorCode.PSYNC_S0001;
+/**
+ * Indicates replication is aborted.
+ *
+ * This is not an actual error - rather just an indication
+ * that something requested the replication should stop.
+ */
+export class ReplicationAbortedError extends ServiceError {
+    constructor(description) {
+        super({
+            code: ReplicationAbortedError.CODE,
+            description: description ?? 'Replication aborted'
+        });
+    }
+}
+ReplicationAbortedError.CODE = ErrorCode.PSYNC_S1103;
+export class AuthorizationError extends ServiceError {
+    constructor(errors) {
+        super({
+            code: AuthorizationError.CODE,
+            status: 401,
+            description: 'Authorization failed',
+            details: errors
+        });
+    }
+}
+AuthorizationError.CODE = ErrorCode.PSYNC_S2101;
+export class InternalServerError extends ServiceError {
+    constructor(err) {
+        super({
+            code: InternalServerError.CODE,
+            severity: ErrorSeverity.ERROR,
+            status: 500,
+            description: 'Something went wrong',
+            details: err.message,
+            stack: process.env.NODE_ENV !== 'production' ? err.stack : undefined
+        });
+    }
+}
+InternalServerError.CODE = ErrorCode.PSYNC_S2001;
+export class RouteNotFound extends ServiceError {
+    constructor(path) {
+        super({
+            code: RouteNotFound.CODE,
+            status: 404,
+            description: 'The path does not exist on this server',
+            details: `The path ${JSON.stringify(path)} does not exist on this server`,
+            severity: ErrorSeverity.INFO
+        });
+    }
+}
+RouteNotFound.CODE = ErrorCode.PSYNC_S2002;
+export class DatabaseConnectionError extends ServiceError {
+    constructor(code, message, cause) {
+        super({
+            code: code,
+            status: 500,
+            description: message,
+            details: `cause: ${cause.message}`,
+            stack: process.env.NODE_ENV !== 'production' ? cause.stack : undefined
+        });
+        this.cause = cause;
+    }
+}
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,MAAM,CAAN,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,8BAAa,CAAA;IACb,oCAAmB,CAAA;IACnB,gCAAe,CAAA;AACjB,CAAC,EAJW,aAAa,KAAb,aAAa,QAIxB;AAkBD,MAAM,OAAO,YAAa,SAAQ,KAAK;IAKrC,MAAM,CAAC,cAAc,CAAC,KAAU;QAC9B,OAAO,KAAK,YAAY,YAAY,IAAI,KAAK,EAAE,gBAAgB,IAAI,IAAI,CAAC;IAC1E,CAAC;IAEO,MAAM,CAAC,YAAY,CAAC,IAA2B,EAAE,WAAoB;QAC3E,IAAI,OAAO,IAAI,IAAI,QAAQ,EAAE,CAAC;YAC5B,IAAI,GAAG;gBACL,IAAI,EAAE,IAAI;gBACV,WAAW,EAAE,WAAY;aAC1B,CAAC;QACJ,CAAC;QACD,IAAI,OAAO,GAAG,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC;QACnD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;QACnC,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAKD,YAAY,IAA2B,EAAE,WAAoB;QAC3D,KAAK,CAAC,YAAY,CAAC,YAAY,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC;QA1BtD,qBAAgB,GAAG,IAAI,CAAC;QA2BtB,IAAI,OAAO,IAAI,IAAI,QAAQ,EAAE,CAAC;YAC5B,IAAI,GAAG;gBACL,IAAI,EAAE,IAAI;gBACV,WAAW,EAAE,WAAY;aAC1B,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAC1B,CAAC;QAED,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QAC/C,IAAI,CAAC,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;IAClC,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,MAAM;QACJ,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,EAAE,CAAC;YAC1C,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;QACD,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI;YACzB,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI;YACzB,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM;YAC7B,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW;YACvC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO;YAC/B,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ;YACjC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ;YACjC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM;SAC9B,CAAC;IACJ,CAAC;IAED,UAAU,CAAC,EAAU;QACnB,IAAI,CAAC,SAAS,CAAC,QAAQ,GAAG,EAAE,CAAC;IAC/B,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,YAAY;IAG/C,YAAY,MAAW;QACrB,KAAK,CAAC;YACJ,IAAI,EAAE,eAAe,CAAC,IAAI;YAC1B,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,mBAAmB;YAChC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;SAChC,CAAC,CAAC;IACL,CAAC;;AATe,oBAAI,GAAG,SAAS,CAAC,WAAW,CAAC;AAY/C;;;;;;GAMG;AACH,MAAM,OAAO,yBAA0B,SAAQ,YAAY;IAEzD,YAAY,WAAmB;QAC7B,KAAK,CAAC;YACJ,IAAI,EAAE,yBAAyB,CAAC,IAAI;YACpC,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,WAAW;SACzB,CAAC,CAAC;IACL,CAAC;;AAPe,8BAAI,GAAG,SAAS,CAAC,WAAW,CAAC;AAU/C;;;;;;GAMG;AACH,MAAM,OAAO,qBAAsB,SAAQ,YAAY;IAErD,YAAY,WAAmB;QAC7B,KAAK,CAAC;YACJ,IAAI,EAAE,qBAAqB,CAAC,IAAI;YAChC,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,WAAW;SACzB,CAAC,CAAC;IACL,CAAC;;AAPe,0BAAI,GAAG,SAAS,CAAC,WAAW,CAAC;AAU/C;;;;;GAKG;AACH,MAAM,OAAO,uBAAwB,SAAQ,YAAY;IAGvD,YAAY,WAAoB;QAC9B,KAAK,CAAC;YACJ,IAAI,EAAE,uBAAuB,CAAC,IAAI;YAClC,WAAW,EAAE,WAAW,IAAI,qBAAqB;SAClD,CAAC,CAAC;IACL,CAAC;;AAPe,4BAAI,GAAG,SAAS,CAAC,WAAW,CAAC;AAU/C,MAAM,OAAO,kBAAmB,SAAQ,YAAY;IAGlD,YAAY,MAAW;QACrB,KAAK,CAAC;YACJ,IAAI,EAAE,kBAAkB,CAAC,IAAI;YAC7B,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,sBAAsB;YACnC,OAAO,EAAE,MAAM;SAChB,CAAC,CAAC;IACL,CAAC;;AATe,uBAAI,GAAG,SAAS,CAAC,WAAW,CAAC;AAY/C,MAAM,OAAO,mBAAoB,SAAQ,YAAY;IAGnD,YAAY,GAAU;QACpB,KAAK,CAAC;YACJ,IAAI,EAAE,mBAAmB,CAAC,IAAI;YAC9B,QAAQ,EAAE,aAAa,CAAC,KAAK;YAC7B,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,sBAAsB;YACnC,OAAO,EAAE,GAAG,CAAC,OAAO;YACpB,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;SACrE,CAAC,CAAC;IACL,CAAC;;AAXe,wBAAI,GAAG,SAAS,CAAC,WAAW,CAAC;AAc/C,MAAM,OAAO,aAAc,SAAQ,YAAY;IAG7C,YAAY,IAAY;QACtB,KAAK,CAAC;YACJ,IAAI,EAAE,aAAa,CAAC,IAAI;YACxB,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,wCAAwC;YACrD,OAAO,EAAE,YAAY,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,gCAAgC;YACzE,QAAQ,EAAE,aAAa,CAAC,IAAI;SAC7B,CAAC,CAAC;IACL,CAAC;;AAVe,kBAAI,GAAG,SAAS,CAAC,WAAW,CAAC;AAa/C,MAAM,OAAO,uBAAwB,SAAQ,YAAY;IAGvD,YAAY,IAAe,EAAE,OAAe,EAAE,KAAU;QACtD,KAAK,CAAC;YACJ,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,OAAO;YACpB,OAAO,EAAE,UAAU,KAAK,CAAC,OAAO,EAAE;YAClC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;SACvE,CAAC,CAAC;QACH,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './errors.js';
+export * from './codes.js';
+export * from './utils.js';

package/dist/index.js

@@ -0,0 +1,4 @@
+export * from './errors.js';
+export * from './codes.js';
+export * from './utils.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC"}

package/dist/utils.d.ts

@@ -0,0 +1,5 @@
+import { ErrorData, ServiceError } from './errors.js';
+export declare const isServiceError: (err: any) => err is ServiceError;
+export declare const asServiceError: (err: any) => ServiceError;
+export declare const getErrorData: (err: Error | any) => ErrorData | undefined;
+export declare const matchesErrorCode: (err: Error | any, code: string) => boolean;

package/dist/utils.js

@@ -0,0 +1,26 @@
+import { InternalServerError, ServiceError } from './errors.js';
+export const isServiceError = (err) => {
+    const matches = ServiceError.isServiceError(err);
+    return !!matches;
+};
+export const asServiceError = (err) => {
+    if (ServiceError.isServiceError(err)) {
+        return err;
+    }
+    else {
+        return new InternalServerError(err);
+    }
+};
+export const getErrorData = (err) => {
+    if (!isServiceError(err)) {
+        return;
+    }
+    return err.toJSON();
+};
+export const matchesErrorCode = (err, code) => {
+    if (isServiceError(err)) {
+        return err.errorData.code === code;
+    }
+    return false;
+};
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,mBAAmB,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3E,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,GAAQ,EAAuB,EAAE;IAC9D,MAAM,OAAO,GAAG,YAAY,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;IACjD,OAAO,CAAC,CAAC,OAAO,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,GAAQ,EAAgB,EAAE;IACvD,IAAI,YAAY,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;QACrC,OAAO,GAAG,CAAC;IACb,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,mBAAmB,CAAC,GAAG,CAAC,CAAC;IACtC,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,GAAgB,EAAyB,EAAE;IACtE,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;QACzB,OAAO;IACT,CAAC;IACD,OAAO,GAAG,CAAC,MAAM,EAAE,CAAC;AACtB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,GAAgB,EAAE,IAAY,EAAE,EAAE;IACjE,IAAI,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;QACxB,OAAO,GAAG,CAAC,SAAS,CAAC,IAAI,KAAK,IAAI,CAAC;IACrC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@powersync/service-errors",
+  "repository": "https://github.com/powersync-ja/powersync-service",
+  "version": "0.0.0-dev-20250122110924",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "license": "FSL-1.1-Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "type": "module",
+  "dependencies": {},
+  "devDependencies": {},
+  "scripts": {
+    "clean": "rm -r ./dist && tsc -b --clean",
+    "build": "tsc -b",
+    "build:tests": "tsc -b test/tsconfig.json",
+    "test": "vitest"
+  }
+}