Library Model on Rekeeply Spec

Content Typing

Mon, 01 Jan 0001 00:00:00 +0000

Content Typing#

Baseline Rules#

content_type is mandatory; entries MUST NOT be created without a type.
content_subtype is optional.
Manual entry creation MUST start with selecting content_type.
After type selection, subtype and other fields may be filled later.

Default and Recommended Set#

The following type/subtype set is available by default and is recommended based on practical personal usage patterns.

`book`#

Purpose: long-form written works and references.

Fields: see Type-Specific Fields.

fiction - fictional books.
non_fiction - non-fictional books.
reference - lookup/reference-oriented books.

`article`#

Purpose: shorter written materials from web or publication sources.

Content Fields

Mon, 01 Jan 0001 00:00:00 +0000

Content Fields#

Field Classes#

system fields are managed by core and MUST NOT be manually edited by users.
user_editable fields are visible and editable by users.
computed fields are derived by core and SHOULD be treated as read-only.

Common Field Baseline#

`system`#

id - immutable entry identifier.
library_id - owning library identifier.
created_at - creation timestamp.
updated_at - last update timestamp.
status_changed_at - timestamp of last status change.

`user_editable`#

content_type - required type key.
content_subtype - optional subtype key.
title - entry title.
status - inbox | todo | in_progress | skimmed | done | dropped.
priority - low | medium | high.
rating - optional integer rating in range 1..10.
recommendation - optional recommendation marker: recommended | neutral | not_recommended.
favorite - independent favorite flag.
archived - independent archive flag.
parent_content_id - optional parent relation.
source_url - optional source link.
summary - optional short description.

`computed`#

search_text - normalized text index for fast search.
last_activity_at - derived last activity timestamp.
is_completed - derived completion flag from status.

Attachment Model#

Content entries MAY have multiple linked attachments.
Attachment links are modeled as related entities, not as one-off fixed fields.
Attachment baseline fields: id, content_id, uri, name (optional), mime (optional), size (optional), created_at.
Attachment export/import baseline dataset file: attachments.ndjson.

Rules#

Clients MUST enforce non-editability for system and computed fields.
Core MUST maintain consistency of all computed fields.
On creation, status SHOULD be auto-set to inbox.
On creation, priority SHOULD be empty by default unless explicitly provided.
Status changes SHOULD update status_changed_at and SHOULD NOT update updated_at.
Favorite flag changes SHOULD NOT update updated_at.
Archived flag changes SHOULD NOT update updated_at.
If rating is provided, value MUST be in range 1..10.
User-editable fields other than content_type and status are optional at creation time and may be filled later.
Type-specific fields are non-mandatory by baseline and become required only when user-defined schema marks them required.
Implementations MAY add extra fields in any class as implementation-defined extensions.

Field Types

Mon, 01 Jan 0001 00:00:00 +0000

Field Types#

Scope#

This section defines allowed field_type values for user-defined fields.
For all field types, required is configurable (true | false).
Default values are configurable when supported by the field type.

Allowed Field Types#

text - short text value.
- Validation: min_length (optional), max_length (optional), pattern (optional), trim_on_save (optional).
- Default: default_value (optional string).
long_text - long multiline text value.
- Validation: min_length (optional), max_length (optional), trim_on_save (optional).
- Default: default_value (optional string).
boolean - true/false value.

Tags#

Position in Model#

Tag is a dedicated library-scoped entity and is NOT a field_type.
Content entries are linked to tags via many-to-many association.

Content Association#

Content-tag relation MUST support multiple tags per content entry.
Core MUST support assigning existing tags to content entries and unassigning tags from content entries.
Core SHOULD support creating tags and assigning them in one logical operation.

Editing Rules#

Renaming a tag updates label without requiring content rewrites.
Removing a tag MUST remove links from content entries but MUST NOT remove content.
Merging tags MAY be supported and SHOULD preserve content links.

Import/Export and Sync#

Tag taxonomy MUST travel with library export/import.
Tag data and tag-content links MUST be synchronized in sync-enabled mode.

Library Actions

Mon, 01 Jan 0001 00:00:00 +0000

Library Actions#

Scope#

These actions define baseline operations for library entries and library tags.

Entry Actions#

create
- Starts with selecting content_type.
- Core auto-fills system fields (id, library_id, created_at, updated_at).
- Core sets default status=inbox and default empty priority.
edit
- Updates user-editable fields.
- Updates updated_at.
set-subtype
- Sets or clears content_subtype.
- MUST NOT change content_type.
- Updates updated_at.
set-status
- Sets status from allowed status set.
- Free transition model (no hard state machine).
- MUST update status_changed_at.
- MUST NOT update updated_at.
set-priority

Schema Actions

Mon, 01 Jan 0001 00:00:00 +0000

Schema Actions#

Scope#

These actions define lifecycle operations for library-scoped schema entities: custom types, custom subtypes, and custom fields.
Schema entities use internal stable key values that are unique within one library scope.

Type Actions#

create-type
- Creates a custom content type in current library.
- Internal key MUST be unique within library.
edit-type
- Updates editable type properties.
- Internal key MUST remain immutable.
archive-type / unarchive-type
- Disables/enables type for active usage in new entries.
- Existing entries using this type remain valid.
delete-type

Presets

Mon, 01 Jan 0001 00:00:00 +0000

Presets#

Contract#

Preset is a saved search definition in library scope.
Preset stores search conditions only.
Preset MUST NOT store sorting or displayed field layout.
Preset MAY be nested using parent_preset_id.
Preset MAY define inherit_query (true|false) for parent query inheritance.
Preset MAY include visual metadata (color, icon).

Operations#

create-preset
update-preset
rename-preset
delete-preset
run-preset

Hierarchy Rules#

Preset hierarchy cycles are forbidden.
If inherit_query=true, resulting query is combined with parent query using baseline AND composition.
If inherit_query=false, parent relation is organizational only.
On parent preset deletion, child presets SHOULD be moved to root level.

User Control#

User can define and edit preset names.
User can define preset order.

Collections

Mon, 01 Jan 0001 00:00:00 +0000

Collections#

Contract#

Collection is a manual library-scoped grouping of content entries.
Collection does NOT store search conditions.
One content entry MAY belong to multiple collections.

Collection Fields#

id (system) - immutable collection identifier.
library_id (system) - owning library scope.
name (user_editable) - collection name.
description (user_editable, optional) - collection description.
color (user_editable, optional) - visual color marker.
icon (user_editable, optional) - visual icon marker.
parent_collection_id (user_editable, optional) - parent collection for hierarchy.
created_at (system) - creation timestamp.
updated_at (system) - update timestamp.

Operations#

create-collection
rename-collection
delete-collection
add-to-collection
remove-from-collection
reorder-collections

Hierarchy Rules#

Parent collection MAY have multiple child collections.
One collection MAY have at most one parent.
Collection hierarchy cycles are forbidden.

Search Behavior

Mon, 01 Jan 0001 00:00:00 +0000

Search Behavior#

Core Rule#

Search and Preset MUST use the same query engine and semantics.

Search vs Preset#

Search is ephemeral by default and is not persisted unless explicitly saved.
Preset is an explicitly persisted search definition.
When current search is changed or library session is restarted, previous ephemeral search result is discarded.
Only explicitly saved presets remain available across sessions.

Searchable Dimensions#

Search MUST support structured conditions by status, priority, rating, recommendation, favorite, archived, content_type, and content_subtype.

Library Lifecycle

Mon, 01 Jan 0001 00:00:00 +0000

Library Lifecycle#

Library Attributes#

id - unique immutable identifier.
name - editable library name.
icon - editable visual marker.

Lifecycle Operations#

create-library
- Creates new library with id, name, and icon.
rename-library
- Updates name only.
- id remains immutable.
update-library-icon
- Updates icon only.
archive-library / unarchive-library
- Archived library MUST NOT be selected as active until restored.
delete-library
- Hard delete requires explicit confirmation.
- Before delete, system SHOULD show related data volume summary.
- If deleted library is active:
  - switch active library to fallback when available;
  - otherwise clear active library until next selection/creation.

Invariants#

Lifecycle operations are account-scoped.
Cross-account lifecycle operations are forbidden.
Library id is stable and never reused in same account scope.

Library Model on Rekeeply Spec

Content Typing

Content Typing#

Baseline Rules#

Default and Recommended Set#

book#

article#

Content Fields

Content Fields#

Field Classes#

Common Field Baseline#

system#

user_editable#

computed#

Attachment Model#

Rules#

Related Sections#

Field Types

Field Types#

Scope#

Allowed Field Types#

Tags

Tags#

Position in Model#

Tag Entity#

Content Association#

Editing Rules#

Import/Export and Sync#

Library Actions

Library Actions#

Scope#

Entry Actions#

Schema Actions

Schema Actions#

Scope#

Type Actions#

Presets

Presets#

Contract#

Operations#

Hierarchy Rules#

User Control#

Collections

Collections#

Contract#

Collection Fields#

Operations#

Hierarchy Rules#

Search Behavior

Search Behavior#

Core Rule#

Search vs Preset#

Searchable Dimensions#

Library Lifecycle

Library Lifecycle#

Library Attributes#

Lifecycle Operations#

Invariants#

`book`#

`article`#

`system`#

`user_editable`#

`computed`#