Service - Variant Standard: Difference between revisions

From Izara Wiki
Jump to navigation Jump to search
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 150: Line 150:
       "optionalOnCreate": false
       "optionalOnCreate": false
     },
     },
    "relId": {
      "type": "string",
      "generatedField": true,
      "requiredOnCreate": false,
      "optionalOnCreate": false,
      "canUpdate": false,
      "validation": {
      }
    }
   },
   },
   "storageResources": {
   "storageResources": {
Line 211: Line 201:
       "optionalOnCreate": false
       "optionalOnCreate": false
     },
     },
    "relId": {
      "type": "string",
      "generatedField": true,
      "requiredOnCreate": false,
      "optionalOnCreate": false,
      "canUpdate": false,
      "validation": {
      }
    }
   },
   },
   "storageResources": {
   "storageResources": {
Line 257: Line 237:
}
}
</syntaxhighlight>
</syntaxhighlight>
= DynamoDB tables =
== [[Standard Config Table Per Service]] ==
=== Configuration tags ===
<syntaxhighlight lang="JavaScript">
{
configTag: "VariantHandlerServiceNameTag"
configKey: "VariantHandlerServiceNameTag"
configValue: xxx // this own services ServiceNameTag, eg "VariantStandard"
}
</syntaxhighlight>
<syntaxhighlight lang="JavaScript">
{
configTag: "ProductGraphServiceName"
configKey: "ProductGraphServiceName"
configValue: xxx // eg: "ProductGraph"
}
</syntaxhighlight>
<syntaxhighlight lang="JavaScript">
{
configTag: "VariantManagerServiceName"
configKey: "VariantManagerServiceName"
configValue: xxx // eg: "ProductManager"
}
</syntaxhighlight>
== LogicalResults ==
Stores results for any requests to perform logical searches on variant data
<syntaxhighlight lang="JavaScript">
{
resultId: xxx // eg: filterMainId for a single logical element
dataId: xxx // one variantId
}
</syntaxhighlight>
* partition key: resultId
* sort key: dataId
= Graph database =
== [[Service - Products Graph]]==
=== Nodes ===
<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{VariantStandardLib.VARIANT_GRAPH_NODE_LABEL}",
schema: {
identifier: true,
restrictProperties: true,
restrictRelationships: true,
properties: {
variantId: {
identifier: true, //(random uuid)
},
variantHandlerServiceNameTag: {
immutable: true,
},
},
}
}
</syntaxhighlight>
<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{VariantStandardLib.VARIANT_PRODUCT_LINK_GRAPH_NODE_LABEL}",
schema: {
identifier: true,
restrictProperties: true,
restrictRelationships: true,
properties: {
variantId: {
identifier: true,
},
variantHandlerServiceNameTag: {
immutable: true,
},
productId: {
identifier: true,
},
productHandlerServiceNameTag: {
immutable: true,
},
},
}
}
</syntaxhighlight>
* adds a node between each variant to product relationship, we do this so we can add variantProductLink specific relationships, eg to media that only relates to this link, not to other parent variants the product has
=== Relationships ===
<syntaxhighlight lang="JavaScript">
{
relationshipType: "{VariantStandardLib.createHasVariantProductLinkGraphRelationshipType()}", // "has_variantProductLink"
schema: {
elementCanBeRemoved: true,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
originTimestamp: //timestamp the request to create/change this relationship was sent
},
}
}
</syntaxhighlight>
<syntaxhighlight lang="JavaScript">
{
relationshipType: "{VariantStandardLib.createDisabledVariantProductLinkGraphRelationshipType()}", //"disabled_variantProductLink"
schema: {
elementCanBeRemoved: true,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
originTimestamp: //timestamp the request to create/change this relationship was sent
},
}
}
</syntaxhighlight>
* links variant to a variantProductLink, or a variantProductLink to a product


= Working documents =
= Working documents =

Latest revision as of 08:40, 13 January 2026

Overview

Handler service for the standard variant type.

Repository

https://bitbucket.org/izara-market-products/izara-market-products-variant-standard/src/master/

Schemas

ObjectSchemas

variantStandard

{
  "objectType": "variantStandard",
  "extendObjType": {
    "serviceTag": "VariantManager",
    "objectType": "variant"
  },
  "storageResources": {
    "graph": {
      "storageType": "graph",
      "graphServerTag": "GraphHandler"
    },
    "dynamoDB": {
      "storageType": "dynamoDB",
      "tableName": "VariantRecord",
      "serviceTag": "VariantManager"
    }
  },
  "fieldNames": {
    "variantId": {
      "storageResourceTags": [
        "graph",
        "dynamoDB"
      ]
    }
  },
  "generatedBy": "userGenerated"
}

variantProductLink

{
  "objectType": "variantProductLink",
  "canDelete": true,
  "belongTo": {
    "serviceTag": "UserAccount",
    "objectType": "user"
  },
  "addOnDataStructure": [],
  "storageResources": {
    "graph": {
      "storageType": "graph",
      "graphServerTag": "GraphHandler"
    }
  },
  "fieldNames": {
    "variantProductLinkId": {
      "type": "string",
      "randomOnCreate": false,
      "requiredOnCreate": false,
      "optionalOnCreate": false,
      "canUpdate": false,
      "validation": {
        "pattern": "^[a-zA-Z0-9_-]+$"
      },
      "storageResourceTags": [
        "graph"
      ],
      "hashOnCreate": [
        "variantId",
        "productId"
      ]
    },
    "variantId": {
      "type": "string",
      "randomOnCreate": false,
      "requiredOnCreate": true,
      "optionalOnCreate": false,
      "canUpdate": false,
      "validation": {
        "pattern": "^[a-zA-Z0-9_-]+$"
      },
      "storageResourceTags": [
        "graph"
      ]
    },
    "productId": {
      "type": "string",
      "randomOnCreate": false,
      "requiredOnCreate": true,
      "optionalOnCreate": false,
      "canUpdate": false,
      "validation": {
        "pattern": "^[a-zA-Z0-9_-]+$"
      },
      "storageResourceTags": [
        "graph"
      ]
    }
  },
  "compositeKeyDeliminator": "_",
  "identifiers": [
    {
      "type": "identifier",
      "fieldName": "variantProductLinkId"
    }
  ],
  "generatedBy": "userGenerated"
}

variantAttributeValueStandard

{
  "objectType": "variantAttributeValueStandard",
  "addOnDataStructure": [],
  "storageResources": {
    "graph": {
      "storageType": "graph",
      "graphServerTag": "GraphHandler"
    }
  },
  "fieldNames": {

  },
  "extendObjType": {
    "objectType": "variantAttributeValue",
    "serviceTag": "VariantManager"
  },
  "generatedBy": "userGenerated"
}

RelationshipSchemas

hasVariantProductLink

{
  "relationshipServiceTag": "VariantStandard",
  "fieldNames": {
    "originTimeStamp": {
      "type": "number",
      "requiredOnCreate": false,
      "canUpdate": true,
      "validation": {

      },
      "optionalOnCreate": false
    },
  },
  "storageResources": {
    "graph": {
      "storageType": "graph",
      "graphServerTag": "GraphHandler"
    }
  },
  "links": [
    {
      "storageResourceTags": [
        "graph"
      ],
      "from": {
        "objType": {
          "serviceTag": "VariantStandard",
          "objectType": "variantProductLink"
        },
        "linkType": "one",
        "requiredOnCreate": true,
        "handler": true
      },
      "to": {
        "objType": {
          "serviceTag": "VariantStandard",
          "objectType": "variantStandard"
        },
        "linkType": "one",
        "handler": true,
        "requiredOnCreate": false
      },
      "canDelete": false
    }
  ],
  "canMove": false
}

disabledVariantProductLink

{
  "relationshipServiceTag": "VariantStandard",
  "fieldNames": {
    "originTimeStamp": {
      "type": "number",
      "requiredOnCreate": false,
      "canUpdate": true,
      "validation": {

      },
      "optionalOnCreate": false
    },
  },
  "storageResources": {
    "graph": {
      "storageType": "graph",
      "graphServerTag": "GraphHandler"
    }
  },
  "links": [
    {
      "storageResourceTags": [
        "graph"
      ],
      "from": {
        "objType": {
          "serviceTag": "VariantStandard",
          "objectType": "variantProductLink"
        },
        "linkType": "one",
        "handler": true,
        "requiredOnCreate": false
      },
      "to": {
        "objType": {
          "serviceTag": "VariantStandard",
          "objectType": "variantStandard"
        },
        "linkType": "one",
        "handler": true,
        "requiredOnCreate": false
      },
      "canDelete": false
    }
  ],
  "canMove": false
}

Working documents

Variant Standard

Retrieved from "https://izara.io/wiki/index.php?title=Service_-_Variant_Standard&oldid=3962"