@objectql/types 1.7.1 → 1.7.3

package/LICENSE

@@ -1,21 +1,118 @@
-MIT License
-
-Copyright (c) 2026 ObjectQL Contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+# PolyForm Shield License 1.0.0
+
+<https://polyformproject.org/licenses/shield/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree
+to them as both strict obligations and conditions to all
+your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the
+software to do everything you might do with the software
+that would otherwise infringe the licensor's copyright
+in it for any permitted purpose. However, you may
+only distribute the software according to [Distribution
+License](#distribution-license) and make changes or new works
+based on the software according to [Changes and New Works
+License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license
+to distribute copies of the software. Your license
+to distribute covers distributing the software with
+changes and new works permitted by [Changes and New Works
+License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of
+the software from you also gets a copy of these terms or the
+URL for them above, as well as copies of any plain-text lines
+beginning with `Required Notice:` that the licensor provided
+with the software. For example:
+
+> Required Notice: Copyright ObjectQL Contributors (https://github.com/objectql)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to
+make changes and new works based on the software for any
+permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that
+covers patent claims the licensor can license, or becomes able
+to license, that you would infringe by using the software.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the
+law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of
+your licenses to anyone else, or prevent the licensor from
+granting licenses to anyone else. These terms do not imply
+any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or
+contributes to infringement of any patent, your patent license
+for the software granted under these terms ends immediately. If
+your company makes such a claim, your patent license ends
+immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have
+violated any of these terms, or done anything with the software
+not covered by your licenses, your licenses can nonetheless
+continue if you come into full compliance with these terms,
+and take practical steps to correct past violations, within
+32 days of receiving notice. Otherwise, all your licenses
+end immediately.
+
+## No Liability
+
+***As far as the law allows, the software comes as is, without
+any warranty or condition, and the licensor will not be liable
+to you for any damages arising out of these terms or the use
+or nature of the software, under any kind of legal claim.***
+
+## Definitions
+
+The **licensor** is the individual or entity offering these
+terms, and the **software** is the software the licensor makes
+available under these terms.
+
+**You** refers to the individual or entity agreeing to these
+terms.
+
+**Your company** is any legal entity, sole proprietorship,
+or other kind of organization that you work for, plus all
+organizations that have control over, are under the control of,
+or are under common control with that organization. **Control**
+means ownership of substantially all the assets of an entity,
+or the power to direct its management and policies by vote,
+contract, or otherwise. Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the
+software under these terms.
+
+**Use** means anything you do with the software requiring one
+of your licenses.
+
+**Permitted purpose** means any purpose other than competing
+with the licensor or any product the licensor or its affiliates
+provides using the software.
+
+---
+
+Required Notice: Copyright (c) 2026 ObjectQL Contributors (https://github.com/objectql)

package/dist/field.d.ts

@@ -1,4 +1,44 @@
 import { FieldValidation, ValidationAiContext } from './validation';
+/**
+ * Attachment field data structure for file and image types.
+ * Stores metadata about uploaded files, with actual file content stored separately.
+ */
+export interface AttachmentData {
+    /** Unique identifier for this file */
+    id?: string;
+    /** File name (e.g., "invoice.pdf") */
+    name: string;
+    /** Publicly accessible URL to the file */
+    url: string;
+    /** File size in bytes */
+    size: number;
+    /** MIME type (e.g., "application/pdf", "image/jpeg") */
+    type: string;
+    /** Original filename as uploaded by user */
+    original_name?: string;
+    /** Upload timestamp (ISO 8601) */
+    uploaded_at?: string;
+    /** User ID who uploaded the file */
+    uploaded_by?: string;
+}
+/**
+ * Image-specific attachment data with additional metadata.
+ * Extends AttachmentData with image-specific properties.
+ */
+export interface ImageAttachmentData extends AttachmentData {
+    /** Image width in pixels */
+    width?: number;
+    /** Image height in pixels */
+    height?: number;
+    /** Thumbnail URL (if generated) */
+    thumbnail_url?: string;
+    /** Alternative sizes/versions */
+    variants?: {
+        small?: string;
+        medium?: string;
+        large?: string;
+    };
+}
 /**
  * Represents the supported field data types in the ObjectQL schema.
  * These types determine how data is stored, validated, and rendered.
@@ -7,8 +47,10 @@ import { FieldValidation, ValidationAiContext } from './validation';
  * - `textarea`: Long string.
  * - `select`: Choice from a list.
  * - `lookup`: Relationship to another object.
+ * - `file`: File attachment. Value stored as AttachmentData (single) or AttachmentData[] (multiple).
+ * - `image`: Image attachment. Value stored as ImageAttachmentData (single) or ImageAttachmentData[] (multiple).
  */
-export type FieldType = 'text' | 'textarea' | 'markdown' | 'html' | 'select' | 'date' | 'datetime' | 'time' | 'number' | 'currency' | 'percent' | 'boolean' | 'email' | 'phone' | 'url' | 'image' | 'file' | 'avatar' | 'location' | 'lookup' | 'master_detail' | 'password' | 'formula' | 'summary' | 'auto_number' | 'object' | 'vector' | 'grid';
+export type FieldType = 'text' | 'textarea' | 'markdown' | 'html' | 'select' | 'date' | 'datetime' | 'time' | 'number' | 'currency' | 'percent' | 'boolean' | 'email' | 'phone' | 'url' | 'image' | 'file' | 'location' | 'lookup' | 'master_detail' | 'password' | 'formula' | 'summary' | 'auto_number' | 'object' | 'vector' | 'grid';
 /**
  * Defines a single option for select/multiselect fields.
  */
@@ -63,6 +105,36 @@ export interface FieldConfig {
      * Specifies the target object name for relationship fields.
      */
     reference_to?: string;
+    /**
+     * Allowed file extensions for file/image fields.
+     * Example: ['.pdf', '.docx'] or ['.jpg', '.png', '.gif']
+     */
+    accept?: string[];
+    /**
+     * Maximum file size in bytes for file/image fields.
+     * Example: 5242880 (5MB)
+     */
+    max_size?: number;
+    /**
+     * Minimum file size in bytes for file/image fields.
+     */
+    min_size?: number;
+    /**
+     * Maximum image width in pixels for image fields.
+     */
+    max_width?: number;
+    /**
+     * Maximum image height in pixels for image fields.
+     */
+    max_height?: number;
+    /**
+     * Minimum image width in pixels for image fields.
+     */
+    min_width?: number;
+    /**
+     * Minimum image height in pixels for image fields.
+     */
+    min_height?: number;
     /** Minimum for number/currency/percent. */
     min?: number;
     /** Maximum for number/currency/percent. */

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@objectql/types",
-  "version": "1.7.1",
+  "version": "1.7.3",
+  "license": "PolyForm-Shield-1.0.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [

package/schemas/object.schema.json

@@ -548,6 +548,13 @@
       "additionalProperties": false,
       "description": "Configuration for a single field on an object. This defines the schema, validation rules, and UI hints for the attribute.",
       "properties": {
+        "accept": {
+          "description": "Allowed file extensions for file/image fields. Example: ['.pdf', '.docx'] or ['.jpg', '.png', '.gif']",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
         "ai_context": {
           "$ref": "#/definitions/ValidationAiContext",
           "description": "AI context for the field. Provides semantic information for AI tools."
@@ -591,18 +598,42 @@
           "description": "Maximum for number/currency/percent.",
           "type": "number"
         },
+        "max_height": {
+          "description": "Maximum image height in pixels for image fields.",
+          "type": "number"
+        },
         "max_length": {
           "description": "Maximum length for text based fields.",
           "type": "number"
         },
+        "max_size": {
+          "description": "Maximum file size in bytes for file/image fields. Example: 5242880 (5MB)",
+          "type": "number"
+        },
+        "max_width": {
+          "description": "Maximum image width in pixels for image fields.",
+          "type": "number"
+        },
         "min": {
           "description": "Minimum for number/currency/percent.",
           "type": "number"
         },
+        "min_height": {
+          "description": "Minimum image height in pixels for image fields.",
+          "type": "number"
+        },
         "min_length": {
           "description": "Minimum length for text based fields.",
           "type": "number"
         },
+        "min_size": {
+          "description": "Minimum file size in bytes for file/image fields.",
+          "type": "number"
+        },
+        "min_width": {
+          "description": "Minimum image width in pixels for image fields.",
+          "type": "number"
+        },
         "multiple": {
           "description": "Whether the field allows multiple values.  Supported by 'select', 'lookup', 'file', 'image'.",
           "type": "boolean"
@@ -687,7 +718,7 @@
       "type": "object"
     },
     "FieldType": {
-      "description": "Represents the supported field data types in the ObjectQL schema. These types determine how data is stored, validated, and rendered.\n\n- `text`: Simple string.\n- `textarea`: Long string.\n- `select`: Choice from a list.\n- `lookup`: Relationship to another object.",
+      "description": "Represents the supported field data types in the ObjectQL schema. These types determine how data is stored, validated, and rendered.\n\n- `text`: Simple string.\n- `textarea`: Long string.\n- `select`: Choice from a list.\n- `lookup`: Relationship to another object.\n- `file`: File attachment. Value stored as AttachmentData (single) or AttachmentData[] (multiple).\n- `image`: Image attachment. Value stored as ImageAttachmentData (single) or ImageAttachmentData[] (multiple).",
       "enum": [
         "text",
         "textarea",
@@ -706,7 +737,6 @@
         "url",
         "image",
         "file",
-        "avatar",
         "location",
         "lookup",
         "master_detail",