@terreno/api 0.0.1

package/dist/populate.js

@@ -0,0 +1,315 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOpenApiSpecForModel = getOpenApiSpecForModel;
+exports.unpopulate = unpopulate;
+var isArray_1 = __importDefault(require("lodash/isArray"));
+var mongoose_to_swagger_1 = __importDefault(require("mongoose-to-swagger"));
+var errors_1 = require("./errors");
+var m2sOptions = {
+    props: ["readOnly", "required", "enum", "default"],
+};
+// This function filters an object to only include specified keys.
+// It supports nested keys using dot notation (e.g., 'user.name').
+// If no keys are provided, it returns the original object.
+// The function recursively traverses the object structure to handle nested properties.
+var filterKeys = function (obj, keysToKeep) {
+    if (!keysToKeep) {
+        return obj;
+    }
+    var result = {};
+    var filterNestedKeys = function (currentObj, currentResult, remainingKeys) {
+        var currentKey = remainingKeys[0];
+        var nestedKeys = currentKey.split(".");
+        if (nestedKeys.length > 1) {
+            var _a = __read(nestedKeys), firstKey = _a[0], rest = _a.slice(1);
+            if (firstKey === "__proto__" || firstKey === "constructor" || firstKey === "prototype") {
+                return;
+            }
+            if (!currentResult[firstKey]) {
+                currentResult[firstKey] = {};
+            }
+            filterNestedKeys(currentObj[firstKey], currentResult[firstKey], __spreadArray([
+                rest.join(".")
+            ], __read(remainingKeys.slice(1)), false));
+        }
+        else {
+            // biome-ignore lint/suspicious/noPrototypeBuiltins: we need to use the prototype to check if the object has the property
+            if (Object.prototype.hasOwnProperty.call(currentObj, currentKey)) {
+                currentResult[currentKey] = currentObj[currentKey];
+            }
+            if (remainingKeys.length > 1) {
+                filterNestedKeys(currentObj, currentResult, remainingKeys.slice(1));
+            }
+        }
+    };
+    filterNestedKeys(obj, result, keysToKeep);
+    return result;
+};
+// Helper function to get the path in the OpenAPI schema, so we can swap out the type for the
+// populated model component or generated type.
+function getPathInSchema(schema, path) {
+    var _a;
+    var keys = path.split(".");
+    var currentSchema = schema;
+    var fullPath = "";
+    for (var i = 0; i < keys.length; i++) {
+        var key = keys[i];
+        if ((_a = currentSchema.properties) === null || _a === void 0 ? void 0 : _a[key]) {
+            fullPath += fullPath ? ".".concat(key) : key;
+            currentSchema = currentSchema.properties[key];
+            // If it's an array, add 'items' to the path
+            if (currentSchema.type === "array" && currentSchema.items) {
+                fullPath += ".items";
+                currentSchema = currentSchema.items;
+            }
+        }
+        else if (i === keys.length - 1 && currentSchema.type === "array") {
+            // If we're at the last key and it's an array, we don't need to add anything
+            break;
+        }
+        else {
+            throw new Error("Path ".concat(path, " not found in schema at key ").concat(key));
+        }
+    }
+    return fullPath;
+}
+// Replaces populated properties with the populated schema.
+function getOpenApiSpecForModel(model, _a) {
+    var e_1, _b, _c, e_2, _d, e_3, _e, e_4, _f;
+    var _g, _h, _j, _k;
+    var _l = _a === void 0 ? {} : _a, populatePaths = _l.populatePaths, extraModelProperties = _l.extraModelProperties;
+    var modelSwagger = (0, mongoose_to_swagger_1.default)(model, {
+        props: ["required", "enum"],
+    });
+    if (populatePaths && (0, isArray_1.default)(populatePaths)) {
+        try {
+            for (var populatePaths_1 = __values(populatePaths), populatePaths_1_1 = populatePaths_1.next(); !populatePaths_1_1.done; populatePaths_1_1 = populatePaths_1.next()) {
+                var populatePath = populatePaths_1_1.value;
+                // Get the referenced populate model from the model schema
+                var populateModel = (_h = (_g = model.schema.path(populatePath.path)) === null || _g === void 0 ? void 0 : _g.options) === null || _h === void 0 ? void 0 : _h.ref;
+                var populatePathIsArray = Array.isArray(model.schema.path(populatePath.path).options.type);
+                if (populatePathIsArray) {
+                    populateModel = model.schema.path(populatePath.path).options.type[0].ref;
+                }
+                if (!populateModel) {
+                    continue;
+                }
+                // Get the properties of the referenced model
+                var properties = filterKeys((0, mongoose_to_swagger_1.default)(model.db.model(populateModel), m2sOptions).properties, populatePath.fields);
+                // Get the OpenAPI path for the current populate path
+                var openApiPath = getPathInSchema(modelSwagger, populatePath.path);
+                // Determine the schema to set
+                var schemaToSet = void 0;
+                if (populatePath.openApiComponent) {
+                    schemaToSet = {
+                        $ref: "#/components/schemas/".concat(populatePath.openApiComponent),
+                    };
+                }
+                else {
+                    schemaToSet = {
+                        properties: properties,
+                        type: "object",
+                    };
+                }
+                // Navigate through the nested structure and set the schema
+                var pathParts = openApiPath.split(".");
+                var currentSchema = modelSwagger.properties;
+                for (var i = 0; i < pathParts.length; i++) {
+                    var part = pathParts[i];
+                    if (i === pathParts.length - 1) {
+                        // We're at the last part, merge the schema
+                        if ((_j = currentSchema[part]) === null || _j === void 0 ? void 0 : _j.properties) {
+                            currentSchema[part].properties = __assign(__assign({}, currentSchema[part].properties), (schemaToSet.properties || (_c = {}, _c[part] = schemaToSet, _c)));
+                        }
+                        else {
+                            currentSchema[part] = schemaToSet;
+                        }
+                    }
+                    else {
+                        // We're still navigating, ensure the path exists
+                        if (!currentSchema[part]) {
+                            currentSchema[part] = {};
+                        }
+                        if (part === "items" && i < pathParts.length - 1) {
+                            // If we're at 'items' and it's not the last part, it should be an object
+                            if (!currentSchema[part].properties) {
+                                currentSchema[part] = { properties: {}, type: "object" };
+                            }
+                        }
+                        currentSchema = currentSchema[part].properties || currentSchema[part];
+                    }
+                }
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (populatePaths_1_1 && !populatePaths_1_1.done && (_b = populatePaths_1.return)) _b.call(populatePaths_1);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+    }
+    try {
+        // Add virtuals to the modelSwagger property
+        for (var _m = __values(Object.keys(model.schema.virtuals)), _o = _m.next(); !_o.done; _o = _m.next()) {
+            var virtual = _o.value;
+            // Skip Mongoose internals
+            if (virtual === "id" || virtual === "__v") {
+                continue;
+            }
+            modelSwagger.properties[virtual] = {
+                type: "any",
+            };
+        }
+    }
+    catch (e_2_1) { e_2 = { error: e_2_1 }; }
+    finally {
+        try {
+            if (_o && !_o.done && (_d = _m.return)) _d.call(_m);
+        }
+        finally { if (e_2) throw e_2.error; }
+    }
+    // Check subschemas for virtuals (one level deep)
+    if (model.schema.childSchemas.length > 0) {
+        try {
+            for (var _p = __values(model.schema.childSchemas), _q = _p.next(); !_q.done; _q = _p.next()) {
+                var childSchema = _q.value;
+                try {
+                    for (var _r = (e_4 = void 0, __values(Object.keys(childSchema.schema.virtuals))), _s = _r.next(); !_s.done; _s = _r.next()) {
+                        var virtual = _s.value;
+                        if (virtual === "id" || virtual === "__v") {
+                            continue;
+                        }
+                        modelSwagger.properties[childSchema.model.path].properties[virtual] = {
+                            type: "any",
+                        };
+                    }
+                }
+                catch (e_4_1) { e_4 = { error: e_4_1 }; }
+                finally {
+                    try {
+                        if (_s && !_s.done && (_f = _r.return)) _f.call(_r);
+                    }
+                    finally { if (e_4) throw e_4.error; }
+                }
+            }
+        }
+        catch (e_3_1) { e_3 = { error: e_3_1 }; }
+        finally {
+            try {
+                if (_q && !_q.done && (_e = _p.return)) _e.call(_p);
+            }
+            finally { if (e_3) throw e_3.error; }
+        }
+    }
+    return {
+        properties: __assign(__assign({}, modelSwagger.properties), extraModelProperties),
+        required: (_k = modelSwagger.required) !== null && _k !== void 0 ? _k : [],
+    };
+}
+// Helper function to unpopulate a document that has been populated.
+// This is helpful for supporting backwards compatibility. E.g. you use populatePaths
+// to populate a document but if the version header for the request is below the version
+// that the populatePath was added, we remove the population and just return the _id.
+function unpopulate(doc, path) {
+    if (!path) {
+        throw new errors_1.APIError({ status: 500, title: "path is required for unpopulate" });
+    }
+    var pathParts = path.split(".");
+    // Recursive because we need to support nested paths.
+    var recursiveUnpopulate = function (current, parts) {
+        var e_5, _a;
+        var _b;
+        var part = parts[0];
+        // If the path doesn't exist, return the original doc
+        if (!current[part]) {
+            return doc;
+        }
+        if (parts.length === 1) {
+            // Base case: we've reached the last part of the path
+            if (Array.isArray(current[part])) {
+                // If the field is an array, recursively unpopulate each element
+                current[part] = current[part].map(function (item) {
+                    return (item === null || item === void 0 ? void 0 : item._id) ? item._id : item;
+                });
+            }
+            else if ((_b = current[part]) === null || _b === void 0 ? void 0 : _b._id) {
+                // If the field is a populated document, revert to _id
+                current[part] = current[part]._id;
+            }
+        }
+        else {
+            // Recursive case: continue down the path
+            if (Array.isArray(current[part])) {
+                try {
+                    for (var _c = __values(current[part]), _d = _c.next(); !_d.done; _d = _c.next()) {
+                        var item = _d.value;
+                        recursiveUnpopulate(item, parts.slice(1)); // Recursively handle each item in the array
+                    }
+                }
+                catch (e_5_1) { e_5 = { error: e_5_1 }; }
+                finally {
+                    try {
+                        if (_d && !_d.done && (_a = _c.return)) _a.call(_c);
+                    }
+                    finally { if (e_5) throw e_5.error; }
+                }
+            }
+            else {
+                recursiveUnpopulate(current[part], parts.slice(1)); // Recursively handle the next part
+            }
+        }
+        return current;
+    };
+    return recursiveUnpopulate(doc, pathParts);
+}

package/dist/populate.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/populate.test.js

@@ -0,0 +1,133 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var bun_test_1 = require("bun:test");
+var populate_1 = require("./populate");
+var tests_1 = require("./tests");
+(0, bun_test_1.describe)("populate functions", function () {
+    var admin;
+    var notAdmin;
+    var spinach;
+    (0, bun_test_1.beforeEach)(function () { return __awaiter(void 0, void 0, void 0, function () {
+        var _a, _b;
+        return __generator(this, function (_c) {
+            switch (_c.label) {
+                case 0: return [4 /*yield*/, (0, tests_1.setupDb)()];
+                case 1:
+                    _a = __read.apply(void 0, [_c.sent(), 2]), admin = _a[0], notAdmin = _a[1];
+                    return [4 /*yield*/, Promise.all([
+                            tests_1.FoodModel.create({
+                                calories: 1,
+                                created: new Date("2021-12-03T00:00:20.000Z"),
+                                eatenBy: [admin._id],
+                                hidden: false,
+                                likesIds: [
+                                    { likes: true, userId: admin._id },
+                                    { likes: false, userId: notAdmin._id },
+                                ],
+                                name: "Spinach",
+                                ownerId: admin._id,
+                                source: {
+                                    name: "Brand",
+                                },
+                            }),
+                        ])];
+                case 2:
+                    _b = __read.apply(void 0, [_c.sent(), 1]), spinach = _b[0];
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("unpopulate", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var populated, unpopulated;
+        var _a, _b;
+        return __generator(this, function (_c) {
+            switch (_c.label) {
+                case 0: return [4 /*yield*/, spinach.populate("ownerId")];
+                case 1:
+                    populated = _c.sent();
+                    return [4 /*yield*/, populated.populate("eatenBy")];
+                case 2:
+                    populated = _c.sent();
+                    return [4 /*yield*/, populated.populate("likesIds.userId")];
+                case 3:
+                    populated = _c.sent();
+                    (0, bun_test_1.expect)(populated.ownerId.name).toBe("Admin");
+                    (0, bun_test_1.expect)(populated.eatenBy[0].id).toBe(admin.id);
+                    (0, bun_test_1.expect)(populated.eatenBy[0].name).toBe("Admin");
+                    (0, bun_test_1.expect)(populated.likesIds[0].userId.id).toBe(admin.id);
+                    (0, bun_test_1.expect)(populated.likesIds[0].userId.name).toBe("Admin");
+                    (0, bun_test_1.expect)(populated.likesIds[1].userId.id).toBe(notAdmin.id);
+                    (0, bun_test_1.expect)(populated.likesIds[1].userId.name).toBe("Not Admin");
+                    unpopulated = (0, populate_1.unpopulate)(populated, "ownerId");
+                    (0, bun_test_1.expect)(spinach.ownerId.name).toBeUndefined();
+                    (0, bun_test_1.expect)(unpopulated.ownerId.toString()).toBe(admin.id);
+                    // Ensure nothing else was touched.
+                    (0, bun_test_1.expect)(populated.likesIds[0].userId.id).toBe(admin.id);
+                    (0, bun_test_1.expect)(populated.likesIds[0].userId.name).toBe("Admin");
+                    (0, bun_test_1.expect)(populated.likesIds[1].userId.id).toBe(notAdmin.id);
+                    (0, bun_test_1.expect)(populated.likesIds[1].userId.name).toBe("Not Admin");
+                    unpopulated = (0, populate_1.unpopulate)(populated, "eatenBy");
+                    (0, bun_test_1.expect)(populated.eatenBy.toString()).toBe(admin.id);
+                    (0, bun_test_1.expect)((_a = populated.eatenBy[0]) === null || _a === void 0 ? void 0 : _a.name).toBeUndefined();
+                    unpopulated = (0, populate_1.unpopulate)(populated, "likesIds.userId");
+                    (0, bun_test_1.expect)(populated.likesIds[0].userId.toString()).toBe(admin.id);
+                    (0, bun_test_1.expect)((_b = populated.likesIds[0].userId) === null || _b === void 0 ? void 0 : _b.name).toBeUndefined();
+                    (0, bun_test_1.expect)(populated.likesIds[1].userId.toString()).toBe(notAdmin.id);
+                    (0, bun_test_1.expect)(populated.likesIds[1].userId.name).toBeUndefined();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});

package/dist/response.js

@@ -0,0 +1 @@
+"use strict";

package/dist/tests/bunSetup.d.ts

@@ -0,0 +1 @@
+export {};