@salesforce/lds-store-sql 1.100.1

package/LICENSE.txt

@@ -0,0 +1,82 @@
+Terms of Use
+
+Copyright 2022 Salesforce, Inc. All rights reserved.
+
+These Terms of Use govern the download, installation, and/or use of this
+software provided by Salesforce, Inc. ("Salesforce") (the "Software"), were
+last updated on April 15, 2022, and constitute a legally binding
+agreement between you and Salesforce. If you do not agree to these Terms of
+Use, do not install or use the Software.
+
+Salesforce grants you a worldwide, non-exclusive, no-charge, royalty-free
+copyright license to reproduce, prepare derivative works of, publicly
+display, publicly perform, sublicense, and distribute the Software and
+derivative works subject to these Terms. These Terms shall be included in
+all copies or substantial portions of the Software.
+
+Subject to the limited rights expressly granted hereunder, Salesforce
+reserves all rights, title, and interest in and to all intellectual
+property subsisting in the Software. No rights are granted to you hereunder
+other than as expressly set forth herein. Users residing in countries on
+the United States Office of Foreign Assets Control sanction list, or which
+are otherwise subject to a US export embargo, may not use the Software.
+
+Implementation of the Software may require development work, for which you
+are responsible. The Software may contain bugs, errors and
+incompatibilities and is made available on an AS IS basis without support,
+updates, or service level commitments.
+
+Salesforce reserves the right at any time to modify, suspend, or
+discontinue, the Software (or any part thereof) with or without notice. You
+agree that Salesforce shall not be liable to you or to any third party for
+any modification, suspension, or discontinuance.
+
+You agree to defend Salesforce against any claim, demand, suit or
+proceeding made or brought against Salesforce by a third party arising out
+of or accruing from (a) your use of the Software, and (b) any application
+you develop with the Software that infringes any copyright, trademark,
+trade secret, trade dress, patent, or other intellectual property right of
+any person or defames any person or violates their rights of publicity or
+privacy (each a "Claim Against Salesforce"), and will indemnify Salesforce
+from any damages, attorney fees, and costs finally awarded against
+Salesforce as a result of, or for any amounts paid by Salesforce under a
+settlement approved by you in writing of, a Claim Against Salesforce,
+provided Salesforce (x) promptly gives you written notice of the Claim
+Against Salesforce, (y) gives you sole control of the defense and
+settlement of the Claim Against Salesforce (except that you may not settle
+any Claim Against Salesforce unless it unconditionally releases Salesforce
+of all liability), and (z) gives you all reasonable assistance, at your
+expense.
+
+WITHOUT LIMITING THE GENERALITY OF THE FOREGOING, THE SOFTWARE IS NOT
+SUPPORTED AND IS PROVIDED "AS IS," WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED. IN NO EVENT SHALL SALESFORCE HAVE ANY LIABILITY FOR ANY DAMAGES,
+INCLUDING, BUT NOT LIMITED TO, DIRECT, INDIRECT, SPECIAL, INCIDENTAL,
+PUNITIVE, OR CONSEQUENTIAL DAMAGES, OR DAMAGES BASED ON LOST PROFITS, DATA,
+OR USE, IN CONNECTION WITH THE SOFTWARE, HOWEVER CAUSED AND WHETHER IN
+CONTRACT, TORT, OR UNDER ANY OTHER THEORY OF LIABILITY, WHETHER OR NOT YOU
+HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+These Terms of Use shall be governed exclusively by the internal laws of
+the State of California, without regard to its conflicts of laws
+rules. Each party hereby consents to the exclusive jurisdiction of the
+state and federal courts located in San Francisco County, California to
+adjudicate any dispute arising out of or relating to these Terms of Use and
+the download, installation, and/or use of the Software. Except as expressly
+stated herein, these Terms of Use constitute the entire agreement between
+the parties, and supersede all prior and contemporaneous agreements,
+proposals, or representations, written or oral, concerning their subject
+matter. No modification, amendment, or waiver of any provision of these
+Terms of Use shall be effective unless it is by an update to these Terms of
+Use that Salesforce makes available, or is in writing and signed by the
+party against whom the modification, amendment, or waiver is to be
+asserted.
+
+Data Privacy: Salesforce may collect, process, and store device,
+system, and other information related to your use of the Software. This
+information includes, but is not limited to, IP address, user metrics, and
+other data ("Usage Data"). Salesforce may use Usage Data for analytics,
+product development, and marketing purposes. You acknowledge that files
+generated in conjunction with the Software may contain sensitive or
+confidential data, and you are solely responsible for anonymizing and
+protecting such data.

package/dist/SqliteStore.d.ts

@@ -0,0 +1,61 @@
+/**
+ * The type of scalar values supported by SqliteStore.
+ *
+ * This is a subset of all types supported by Sqlite itself, but
+ * may expand in the future if more types need to be used in LDS.
+ */
+export type SqliteType = string | number | null;
+/**
+ * A result from executing a query against a SqliteStore.
+ *
+ * This type is a compromise between efficiency and ergonomics
+ * that hopefully strikes a good balance. It includes the column
+ * names in the result but avoids duplicating them for every row
+ * in the result set. Rows are packed as an array of arrays of
+ * values.
+ *
+ * Each row array is expected to contain the same number of values
+ * as the columns array, and the order of items in a row corresponds
+ * to the order in the columns array.
+ */
+export interface SqliteResult {
+    columns: string[];
+    rows: SqliteType[][];
+}
+/**
+ * A `SqliteStore` is a durable store type that is backed by a
+ * Sqlite database with a well-known schema.
+ *
+ * Example implementations of this interface might be a native
+ * implementation using SQLCipher, or a browser implementation
+ * that uses sqlite.js.
+ *
+ * Because all implementations of this interface are known to be
+ * powered by Sqlite, the store can safely make use of
+ * features such as views, partial indexes, virtual columns, and
+ * extensions that are part of Sqlite.
+ */
+export interface SqliteStore {
+    /**
+     * Generally, all SqliteStore implementations should support raw SQL queries.
+     * However, an implementation may choose to return `false` in some cases, e.g.
+     * if the schema version at runtime does not match any currently supported or
+     * well-known schema revisions.
+     *
+     * @returns true if the implementation supports SQL evaluation.
+     */
+    isEvalSupported(): boolean;
+    /**
+     * Executes the specified query and returns the result.
+     *
+     * This method will eagerly retrieve all rows of the result set and
+     * include them in the returned result object.
+     *
+     * NOTE: positional parameters are bound first, followed by named parameters.
+     *
+     * @param sql the sql query to execute
+     * @param params an array of positional parameters used in the `sql` query
+     * @see sqlite3_exec
+     */
+    query(sql: string, params: SqliteType[]): Promise<SqliteResult>;
+}

package/dist/SqliteStore.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=SqliteStore.js.map

package/dist/SqliteStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SqliteStore.js","sourceRoot":"","sources":["../src/SqliteStore.ts"],"names":[],"mappings":""}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { SqliteResult, SqliteType, SqliteStore } from './SqliteStore';

package/dist/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,27 @@
+{
+    "name": "@salesforce/lds-store-sql",
+    "version": "1.100.1",
+    "license": "SEE LICENSE IN LICENSE.txt",
+    "description": "Interfaces and classes for evaluating SQL against a store (most commonly a DurableStore)",
+    "types": "dist/index.d.ts",
+    "main": "dist/index.js",
+    "module": "dist/index.js",
+    "files": [
+        "dist"
+    ],
+    "exports": {
+        ".": {
+            "import": "./dist/index.js",
+            "types": "./dist/index.d.ts",
+            "default": "./dist/index.js"
+        }
+    },
+    "scripts": {
+        "prepare": "yarn build",
+        "clean": "rm -rf dist",
+        "build": "tsc"
+    },
+    "devDependencies": {
+        "@luvio/environments": "0.135.4"
+    }
+}