@compas/store
Version:
Postgres & S3-compatible wrappers for common things
513 lines (493 loc) • 15.2 kB
JavaScript
// Generated by @compas/code-gen
import { wrapQueryPart } from "../common/database-helpers.js";
import { validateQueryResultStoreSessionStore } from "../queryResult/validators.js";
import {
validateStoreSessionStore,
validateStoreSessionStoreInsertValidated,
validateStoreSessionStoreOrderBy,
validateStoreSessionStoreOrderBySpec,
validateStoreSessionStoreQueryBuilderValidated,
validateStoreSessionStoreUpdateValidated,
validateStoreSessionStoreWhereValidated,
} from "../store/validators.js";
import { sessionStoreTokenQueryBuilderSpec, sessionStoreTokenWhereSpec } from "./sessionStoreToken.js";
import { AppError, isNil } from "@compas/stdlib";
import {
generatedQueryBuilderHelper,
generatedUpdateHelper,
generatedWhereBuilderHelper,
isQueryPart,
query,
} from "@compas/store";
export const sessionStoreQueries = {
sessionStoreCount,
sessionStoreInsert,
sessionStoreUpdate,
sessionStoreDelete,
sessionStoreUpsertOnId,
};
/** @type {any} */
export const sessionStoreWhereSpec = {
"fieldSpecification": [
{
"tableKey": "id",
"keyType": "uuid",
"matchers": [
{
"matcherKey": "id",
"matcherType": "equal"
},
{
"matcherKey": "idNotEqual",
"matcherType": "notEqual"
},
{
"matcherKey": "idIn",
"matcherType": "in"
},
{
"matcherKey": "idNotIn",
"matcherType": "notIn"
}
]
},
{
"tableKey": "createdAt",
"keyType": "timestamptz",
"matchers": [
{
"matcherKey": "createdAt",
"matcherType": "equal"
},
{
"matcherKey": "createdAtNotEqual",
"matcherType": "notEqual"
},
{
"matcherKey": "createdAtIn",
"matcherType": "in"
},
{
"matcherKey": "createdAtNotIn",
"matcherType": "notIn"
},
{
"matcherKey": "createdAtGreaterThan",
"matcherType": "greaterThan"
},
{
"matcherKey": "createdAtLowerThan",
"matcherType": "lowerThan"
}
]
},
{
"tableKey": "updatedAt",
"keyType": "timestamptz",
"matchers": [
{
"matcherKey": "updatedAt",
"matcherType": "equal"
},
{
"matcherKey": "updatedAtNotEqual",
"matcherType": "notEqual"
},
{
"matcherKey": "updatedAtIn",
"matcherType": "in"
},
{
"matcherKey": "updatedAtNotIn",
"matcherType": "notIn"
},
{
"matcherKey": "updatedAtGreaterThan",
"matcherType": "greaterThan"
},
{
"matcherKey": "updatedAtLowerThan",
"matcherType": "lowerThan"
}
]
},
{
"tableKey": "accessTokens",
"matchers": [
{
"matcherKey": "viaAccessTokens",
"matcherType": "via",
"relation": {
"entityName": "sessionStoreToken",
"shortName": "sst",
"entityKey": "session",
"referencedKey": "id",
"where": ()=> sessionStoreTokenWhereSpec
}
},
{
"matcherKey": "accessTokensNotExists",
"matcherType": "notExists",
"relation": {
"entityName": "sessionStoreToken",
"shortName": "sst",
"entityKey": "session",
"referencedKey": "id",
"where": ()=> sessionStoreTokenWhereSpec
}
}
]
}
]
};
/**
* Reusable where clause generator. This is used by other generated queries, and can be used inline in custom queries.
*
* @param {import("../common/types.js").StoreSessionStoreWhere} [where]
* @param {{ skipValidator?: boolean, shortName?: string }} [options]
* @returns {import("@compas/store").QueryPart<any>}
*/
export function sessionStoreWhere(where, options = {}) {
options.shortName ??= "ss."
if (!options.shortName.endsWith(".")) { options.shortName += "."; }
if (!options.skipValidator) {
const { error, value } = validateStoreSessionStoreWhereValidated(where ?? {});
if (error) {
throw AppError.serverError({ message: "Invalid where object", error, });
}
where = value
}
return generatedWhereBuilderHelper(sessionStoreWhereSpec, where ?? {}, options.shortName);
}
/**
* Reusable ORDER BY clause generator. This is used by other generated queries, and can be used inline in custom queries.
*
* @param {import("../common/types.js").StoreSessionStoreOrderBy} [orderBy]
* @param {import("../common/types.js").StoreSessionStoreOrderBySpec} [orderBySpec]
* @param {{ skipValidator?: boolean, shortName?: string }} [options]
* @returns {import("@compas/store").QueryPart<any>}
*/
export function sessionStoreOrderBy(orderBy, orderBySpec, options = {}) {
options.shortName ??= "ss."
if (!options.shortName.endsWith(".")) { options.shortName += "."; }
orderBy ??= ["createdAt","updatedAt","id"];
orderBySpec ??= {};
if (!options.skipValidator) {
const validatedOrderBy = validateStoreSessionStoreOrderBy(orderBy);
if (validatedOrderBy.error) {
throw AppError.serverError({ message: "Invalid orderBy array", error: validatedOrderBy.error, });
}
orderBy = validatedOrderBy.value;
const validatedOrderBySpec = validateStoreSessionStoreOrderBySpec(orderBySpec);
if (validatedOrderBySpec.error) {
throw AppError.serverError({ message: "Invalid orderBySpec object", error: validatedOrderBySpec.error, });
}
orderBySpec = validatedOrderBySpec.value;
}
if (isQueryPart(orderBy)) {
return orderBy
}
let str = "";
for (const value of orderBy) {
if(str.length !== 0) {
str += ", ";
}
str += `${options.shortName}"${value}" ${orderBySpec[value] ?? "ASC"}`
}
return query([str]);
}
/**
* Count the records in the 'sessionStore' table
*
* @param {import("@compas/store").Postgres} sql
* @param {import("../common/types.js").StoreSessionStoreWhere} where
* @returns {Promise<number>}
*/
async function sessionStoreCount(sql, where) {
const [result] = await query`select count(ss."id") as "recordCount" FROM "sessionStore" ss WHERE ${sessionStoreWhere(where)}`.exec(sql);
return Number(result?.recordCount ?? "0");
}
/**
* Insert a record in the 'sessionStore' table
*
* @param {import("@compas/store").Postgres} sql
* @param {import("../common/types.js").StoreSessionStoreInsert["insert"]} insert
* @param {{ withPrimaryKey?: boolean }} [_options={}]
* @returns {Promise<import("../common/types.js").StoreSessionStore[]>}
*/
function sessionStoreInsert(sql, insert, _options = {}) {
if (insert === undefined || (Array.isArray(insert) && insert.length === 0)) {
return Promise.resolve([]);
}
return sessionStoreInsertInternal({ insert, returning: "*" }).exec(sql);
}
/**
* Internal compat helper to insert a record in the 'sessionStore' table
*
* @param {import("../common/types.js").StoreSessionStoreInsert} input
* @returns {import("@compas/store").WrappedQueryPart<import("../common/types.js").StoreSessionStore>}
*/
function sessionStoreInsertInternal(input) {
const { error, value: validatedInput } = validateStoreSessionStoreInsertValidated(input);
if (error) {
throw AppError.serverError({
message: "Insert input validation failed",
error,
});
}
const qb = query`
INSERT INTO "sessionStore"
("id","checksum","revokedAt","data","createdAt","updatedAt")
VALUES
`;
/** @type {string[]} */
const str = [];
const args = [];
for (const insert of validatedInput.insert) {
if (str.length) {
str.push(", (");
}
else {
str.push("(");
}
if (isNil(insert.id)) {
args.push(undefined);
str.push("DEFAULT, ");
}
else {
args.push(insert.id);
str.push(", ")
}
args.push(insert.checksum ?? null);
str.push(", ");
args.push(insert.revokedAt ?? null);
str.push(", ");
if (!isNil(insert.data)) {
args.push(JSON.stringify(insert.data));
}
else {
args.push(null);
}
str.push(", ");
if (isNil(insert.createdAt)) {
args.push(undefined);
str.push("DEFAULT, ");
}
else {
args.push(insert.createdAt);
str.push(", ")
}
if (isNil(insert.updatedAt)) {
args.push(undefined);
str.push("DEFAULT, ");
}
else {
args.push(insert.updatedAt);
str.push(", ")
}
// We have added an extra comma, so remove it.
str[str.length -1] = str.at(-1)?.slice(0, -2) ?? "";
args.push(undefined);
str.push(")");
args.push(undefined);
}
if(validatedInput.returning === "*") {
str.push(` RETURNING "id","checksum","revokedAt","data","createdAt","updatedAt"`);
args.push(undefined);
}
else if (Array.isArray(validatedInput.returning)) {
str.push(` RETURNING ${JSON.stringify(validatedInput.returning).slice(1, -1)}`);
args.push(undefined);
}
qb.append(query(str, ...args));
return wrapQueryPart(qb, validateStoreSessionStore, { hasCustomReturning: Array.isArray(validatedInput.returning), });
}
/**
* Upsert a record in the 'sessionStore' table
*
* @param {import("@compas/store").Postgres} sql
* @param {import("../common/types.js").StoreSessionStoreInsert["insert"]} insert
* @returns {Promise<import("../common/types.js").StoreSessionStore[]>}
*/
function sessionStoreUpsertOnId(sql, insert) {
return sessionStoreUpsertOnIdInternal({ insert, returning: "*" }).exec(sql);
}
/**
* Upsert a record in the 'sessionStore' table based on the primary key.
*
* @param {import("../common/types.js").StoreSessionStoreInsert} input
* @returns {import("@compas/store").WrappedQueryPart<import("../common/types.js").StoreSessionStore>}
*/
function sessionStoreUpsertOnIdInternal(input) {
const { error, value: validatedInput } = validateStoreSessionStoreInsertValidated(input);
if (error) {
throw AppError.serverError({
message: "Insert input validation failed",
error,
});
}
const { queryPart } = sessionStoreInsertInternal({ insert: input.insert });
/** @type {string[]} */
const str = [];
const args = []
str.push(`ON CONFLICT ("id") DO UPDATE SET
"checksum" = COALESCE(EXCLUDED."checksum", "sessionStore"."checksum"),
"revokedAt" = COALESCE(EXCLUDED."revokedAt", "sessionStore"."revokedAt"),
"data" = COALESCE(EXCLUDED."data", "sessionStore"."data"),
"updatedAt" = COALESCE(EXCLUDED."updatedAt", "sessionStore"."updatedAt")`);
if(validatedInput.returning === "*") {
str.push(` RETURNING "id","checksum","revokedAt","data","createdAt","updatedAt"`);
args.push(undefined);
}
else if (Array.isArray(validatedInput.returning)) {
str.push(` RETURNING ${JSON.stringify(validatedInput.returning).slice(1, -1)}`);
args.push(undefined);
}
queryPart.append(query(str, ...args));
return wrapQueryPart(queryPart, validateStoreSessionStore, { hasCustomReturning: Array.isArray(validatedInput.returning), });
}
/** @type {any} */
const sessionStoreUpdateSpec = {
"schemaName": "",
"name": "sessionStore",
"shortName": "ss",
"columns": [
"id",
"checksum",
"revokedAt",
"data",
"createdAt",
"updatedAt"
],
"where": sessionStoreWhereSpec,
"injectUpdatedAt": true,
"fields": {
"id": {
"type": "uuid",
"atomicUpdates": []
},
"checksum": {
"type": "string",
"atomicUpdates": [
"$append"
]
},
"revokedAt": {
"type": "date",
"atomicUpdates": [
"$add",
"$subtract"
]
},
"data": {
"type": "jsonb",
"atomicUpdates": [
"$set",
"$remove"
]
},
"createdAt": {
"type": "date",
"atomicUpdates": [
"$add",
"$subtract"
]
},
"updatedAt": {
"type": "date",
"atomicUpdates": [
"$add",
"$subtract"
]
}
}
};
/**
* Update a record in the 'sessionStore' table
*
* @param {import("@compas/store").Postgres} sql
* @param {import("../common/types.js").StoreSessionStoreUpdate} update
* @returns {Promise<import("../common/types.js").StoreSessionStore[]>}
*/
function sessionStoreUpdate(sql, update) {
if (update?.returning === "*" || !update?.returning) {
return sessionStoreUpdateInternal(update).exec(sql);
}
// @ts-expect-error
return sessionStoreUpdateInternal(update).execRaw(sql);
}
/**
* Update records in the 'sessionStore' table
*
* @param {import("../common/types.js").StoreSessionStoreUpdate} input
* @returns {import("@compas/store").WrappedQueryPart<import("../common/types.js").StoreSessionStore>}
*/
function sessionStoreUpdateInternal(input) {
const { error, value: validatedInput } = validateStoreSessionStoreUpdateValidated(input);
if (error) {
throw AppError.serverError({
message: "Update input validation failed",
error,
});
}
return wrapQueryPart(generatedUpdateHelper(sessionStoreUpdateSpec, validatedInput), validateStoreSessionStore, { hasCustomReturning: Array.isArray(validatedInput.returning), });
}
/**
* Delete a record in the 'sessionStore' table
*
* @param {import("@compas/store").Postgres} sql
* @param {import("../common/types.js").StoreSessionStoreWhere} [where]
* @returns {Promise<void>}
*/
function sessionStoreDelete(sql, where = {}) {
return sessionStoreDeleteInternal(where).exec(sql);
}
/**
* Remove records from the 'sessionStore' table
*
* @param {import("../common/types.js").StoreSessionStoreWhere} [where]
* @returns {import("@compas/store").QueryPart<any>}
*/
function sessionStoreDeleteInternal(where = {}) {
return query`DELETE FROM "sessionStore" ss WHERE ${sessionStoreWhere(where)}`;
}
/** @type {any} */
export const sessionStoreQueryBuilderSpec = {
"name": "sessionStore",
"shortName": "ss",
"orderByExperimental": sessionStoreOrderBy,
"where": sessionStoreWhereSpec,
"columns": [
"id",
"checksum",
"revokedAt",
"data",
"createdAt",
"updatedAt"
],
"relations": [
{
"builderKey": "accessTokens",
"ownKey": "id",
"referencedKey": "session",
"returnsMany": true,
"entityInformation": () => sessionStoreTokenQueryBuilderSpec
}
]
};
/**
* Query records in the 'sessionStore' table, optionally joining related tables.
*
* @param {import("../common/types.js").StoreSessionStoreQueryBuilder} [input]
* @returns {import("@compas/store").WrappedQueryPart<import("../common/types.js").QueryResultStoreSessionStore>}
*/
export function querySessionStore(input = {}) {
const { error, value: validatedInput } = validateStoreSessionStoreQueryBuilderValidated(input);
if (error) {
throw AppError.serverError({
message: "Query builder input validation failed",
error,
});
}
return wrapQueryPart(generatedQueryBuilderHelper(sessionStoreQueryBuilderSpec, validatedInput, {}), validateQueryResultStoreSessionStore, { hasCustomReturning: validatedInput.select?.length !== 6, });
}